一、引入依賴html
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.5.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.5.0</version> </dependency>
二、swagger類的編寫web
package com.autohome.fc.loan.dealer.provider.config; import com.google.common.base.Function; import com.google.common.base.Optional; import com.google.common.base.Predicate; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.RequestHandler; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration //讓spring加載該類 @EnableSwagger2 //啓動swagger public class Swagger2 { @Bean public Docket createRestApi() {// 建立API基本信息 return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("XX.provider.controller)) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() {// 建立API的基本信息,這些信息會在Swagger UI中進行顯示 return new ApiInfoBuilder() .title("xx")// API 標題 .description("維護在springboot中的api")// API描述 .contact("xx")// 聯繫人 .version("1.0")// 版本號 .build(); } }
三、接口響應實體對象spring
@ApiModel(value = "錄單信息") public class AccountInfoAPIDto { @ApiModelProperty(value = "錄單人") private String inputBy; @ApiModelProperty(value = "錄單人名稱") private String inputName; @ApiModelProperty(value = "車商|合做網點編 碼") private String dealerCode; @ApiModelProperty(value = "車商|合做網點名 稱") private String dealerName; @ApiModelProperty(value = "代理人編碼") private String agentCode; @ApiModelProperty(value = "代理人名稱") private String agentName;
四、post請求接受參數api
@ApiOperation(value = "信息錄入接口") @Override public ResponseDto submitApply(@ApiParam @RequestBody SubmitApplyRequestDto submitApplyRequestDto) { }
五、get請求接受參數springboot
@ApiOperation(value="發送短信獲取驗證碼") @ApiImplicitParams({ @ApiImplicitParam(name = "flowid", value = "流程號", required = true, paramType = "query", dataType = "String"), @ApiImplicitParam(name = "userId", value = "用戶id", required = true, paramType = "query", dataType = "String") }) @Override public ResponseDto applyVerifyCode(String flowId,String userId) { }
六、實現掃描多個包路徑app
@Configuration //讓spring加載該類 @EnableSwagger2 //啓動swagger public class Swagger2 { // 定義分隔符 private static final String splitor = ";"; @Bean public Docket createRestApi() {// 建立API基本信息 return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(basePackage("XX.provider.controller"+splitor+"XX.provider.web.insurance")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() {// 建立API的基本信息,這些信息會在Swagger UI中進行顯示 return new ApiInfoBuilder() .title("XX")// API 標題 .description("XX")// API描述 .contact("XX")// 聯繫人 .version("1.0")// 版本號 .build(); } public static Predicate<RequestHandler> basePackage(final String basePackage) { return input -> declaringClass(input).transform(handlerPackage(basePackage)).or(true); } private static Function<Class<?>, Boolean> handlerPackage(final String basePackage) { return input -> { // 循環判斷匹配 for (String strPackage : basePackage.split(splitor)) { boolean isMatch = input.getPackage().getName().startsWith(strPackage); if (isMatch) { return true; } } return false; }; } private static Optional<? extends Class<?>> declaringClass(RequestHandler input) { return Optional.fromNullable(input.declaringClass()); } }
七、完成上述代碼添加上,啓動Spring Boot程序,訪問:http://localhost:8080/swagger-ui.htmlide