**
國際慣例-第一步,pom倒包
**
這裏用的是2.8.0版本,想用別的版本的可以去官網上看看目前出到多少版本了。
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.8.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.8.0</version>
</dependency>
第二步-創建swagger.java配置文件
package config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
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
public class Swagger2 implements WebMvcConfigurer {
//訪問路徑 http://本機路徑/swagger-ui.html#/ 我這裏用tomcat啓動就是127.0.0.1:8080
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
.apis(RequestHandlerSelectors.basePackage("com.example.FirstDemo"))//basePackage:需要生成接口文檔的包
.paths(PathSelectors.regex("/FirstDemo/.*"))//包下所有類的接口都會被掃描
.build();
}
@SuppressWarnings("deprecation")
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("總監端 API")
.description("總監端 API")
.termsOfServiceUrl("http://192.168.1.68:8080/")
.contact("liuxiaopeng").version("1.0").build();
}
}
第三步-controller上添加註解
第四步-編寫接口並添加註釋
@ApiOperation(value = "通過id獲取用戶") //value:註釋
@ApiImplicitParams(value = {}) //用在請求的方法上,表示一組參數說明
@GetMapping(value = "helloWorld")
//這裏的GetMapping是註釋GET方法的簡便寫法,同@RequestMapping(value="/helloWorld",method=RequestMethod.GET)
public String SayHello() {
return "helloWrold";
}
第五步-啓動springboot,進入swagger
-
啓動springboot
-
通過http://127.0.0.1:8080/swagger-ui.html#/進入自己本地swagger頁面,這裏的ip是本機ip,根據自己ip填寫,端口號也根據自己tomcat配置的端口號填寫。
-
進入後的頁面
-接口內的頁面
-
點擊右上角的"Try it out"測試接口
打完收工:附註解詳情
註解描述
裏面有詳細描述—轉自—https://blog.csdn.net/xiaojin21cen/article/details/78654652
註解 | 描述 |
---|---|
@Api | 修飾整個類,描述Controller的作用 |
@ApiOperation | 描述一個類的一個方法,或者說一個接口 |
@ApiParam | 單個參數描述 |
@ApiModel | 用對象來接收參數 |
@ApiProperty | 用對象接收參數時,描述對象的一個字段 |
@ApiResponse | HTTP響應其中1個描述 |
@ApiResponses | HTTP響應整體描述 |
@ApiIgnore | 使用該註解忽略這個API |
@ApiError | 發生錯誤返回的信息 |
@ApiImplicitParam | 一個請求參數 |
@ApiImplicitParams | 多個請求參數 |