生活随笔
收集整理的這篇文章主要介紹了
使用swagger编写开发接口文档
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
1.在pom.xml中導入依賴
| <dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version>
</dependency>
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version>
</dependency> |
2.在Controller類中加注解
| 1.在類名上添加注解 @Api(tags = "生成驗證碼")
@EnableSwagger2
public class CodeController ? 2.在方法名上添加注解 ? ①參數少的時候，用： @ApiOperation(value = "獲取驗證碼", httpMethod = "GET", produces = "application/json;charset=UTF-8")
@ApiImplicitParam(value = "時間戳", name = "timestamp") ②參數多的時候，用： @ApiOperation(value = "判斷驗證碼", httpMethod = "GET", produces = "application/json;charset=UTF-8")
@ApiImplicitParams(value = {@ApiImplicitParam(value = "驗證驗證碼", name = "validateCode"),@ApiImplicitParam(value = "時間戳(疑似不用)", name = "timestamp")}) 3.在和controller包同目錄下創建config包，存放SwaggerConfig，代碼如下： | package config; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import springfox.documentation.RequestHandler;
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; @Configuration
@EnableSwagger2
@EnableWebMvc
//掃描的API ?Controller包
@ComponentScan(basePackages = "config")
public class SwaggerConfig {
? ? // 接口文檔構建配置
? ? @Bean
? ? public Docket createRestApi(){
? ? ? ? ? ? return new Docket(DocumentationType.SWAGGER_2)
? ? ? ? ? ? ? ? ? ? .apiInfo(apiInfo())
? ? ? ? ? ? ? ? ? ? .select()//選擇那些路徑和api會生成document
? ? ? ? ? ? ? ? ? ? .apis(RequestHandlerSelectors.basePackage("controller"))//對controller包下的API進行監控
? ? ? ? ? ? ? ? ? ? .paths(PathSelectors.any())//對所有路徑進行監控
? ? ? ? ? ? ? ? ? ? .build();
? ? ? ? }
? ? ? ? //接口文檔信息
? ? private ApiInfo apiInfo(){
? ? ? ? return new ApiInfoBuilder()
? ? ? ? ? ? ? ? .title("RESTFUL API服務接口列表")
? ? ? ? ? ? ? ? .description("API接口")
? ? ? ? ? ? ? ? .version("1.0")
? ? ? ? ? ? ? ? .build();
? ? }
} |
? |
?
然后啟動項目，訪問http://localhost:8080/項目名/swagger-ui.html。即可
總結
以上是生活随笔為你收集整理的使用swagger编写开发接口文档的全部內容，希望文章能夠幫你解決所遇到的問題。
如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。
