Swager是一个API文档自动生成工具,可以用于生成API接口文档,供开发者和用户查看和使用。它可以通过描述API接口的规范,自动生成API文档,使得API接口的发布和使用变得更加简单和规范。
下面是使用Swagger的步骤:
- <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>
- @Configuration
- @EnableSwagger2
- public class SwaggerConfig {
- @Bean
- public Docket api() {
- return new Docket(DocumentationType.SWAGGER_2)
- .select()
- .apis(RequestHandlerSelectors.any())
- .paths(PathSelectors.any())
- .build();
- }
- }
- @RestController
- @RequestMapping("/users")
- @Api(value = "users", description = "Operations for users")
- public class UserController {
-
- @GetMapping("/{id}")
- @ApiOperation(value = "Get user by id", response = User.class)
- public User getUserById(@PathVariable Long id) {
- // your code here
- }
- }
http://localhost:8080/swagger-ui.html
来访问。以上就是使用Swagger的基本步骤,你可以根据项目的需求进行定制化配置。