整合swagger2構建Restful API

在pom.xml中進行版本管理

<swagger.version>2.8.0</swagger.version>

給taosir-api的pom.xml中新增依賴配置

<!-- swagger start -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>${swagger.version}</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>${swagger.version}</version>
</dependency>

新增配置類

package cn.taosir.api.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @EnableSwagger2 @Configuration public class SwaggerConfiguration { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() //控制暴露出去的路徑下的例項 //如果某個介面不想暴露,可以使用以下註解 //@ApiIgnore 這樣,該介面就不會暴露在 swagger2 的頁面下 .apis(RequestHandlerSelectors.basePackage("cn.taosir.api.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("濤先森系統入口業務測試") .version("1.0") .description("API 描述") .build(); } }
 

為控制層新增相應註解

package cn.taosir.api.controller.dreamhouse;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import cn.taosir.service.dreamHouse.UserService; import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; @RestController @Api(value = "使用者管理" ,tags = {"使用者的介面"}) public class UserController { @Autowired private UserService userService; @ApiOperation(value="測試方法", notes="測試是否成功使用服務發現") @RequestMapping(value="/test",method=RequestMethod.GET) public String test() { return userService.test(); } }
 

按順序啟動

taosir-eureka註冊中心

taosir-dreamHouse服務提供者

taoisr-api服務消費者

訪問地址 http://localhost:8765/swagger-ui.html#

以上，整合swagger2構建Restful API

下面附上註解參考表

@Api：用在請求的類上，表示對類的說明
    tags="說明該類的作用，可以在UI介面上看到的註解"
    value="該引數沒什麼意義，在UI介面上也看到，所以不需要配置"
 
@ApiOperation：用在請求的方法上，說明方法的用途、作用
    value="說明方法的用途、作用"
    notes="方法的備註說明"
 
@ApiImplicitParams：用在請求的方法上，表示一組引數說明
    @ApiImplicitParam：用在@ApiImplicitParams註解中，指定一個請求引數的各個方面
        name：引數名
        value：引數的漢字說明、解釋
        required：引數是否必須傳
        paramType：引數放在哪個地方
            · header --> 請求引數的獲取：@RequestHeader · query --> 請求引數的獲取：@RequestParam · path（用於restful介面）--> 請求引數的獲取：@PathVariable · body（不常用） · form（不常用） dataType：引數型別，預設String，其它值dataType="Integer" defaultValue：引數的預設值 @ApiResponses：用在請求的方法上，表示一組響應 @ApiResponse：用在@ApiResponses中，一般用於表達一個錯誤的響應資訊 code：數字，例如400 message：資訊，例如"請求引數沒填好" response：丟擲異常的類 @ApiModel：用於響應類上，表示一個返回響應資料的資訊 （這種一般用在post建立的時候，使用@RequestBody這樣的場景， 請求引數無法使用@ApiImplicitParam註解進行描述的時候） @ApiModelProperty：用在屬性上，描述響應類的屬性 
註解參考表來自：https://blog.csdn.net/qq_28009065/article/details/79104103