swagger 基本用法

Swagger 是一个流行的API开发工具包，用于设计、构建、文档化和使用RESTful web服务。它提供了一套强大的功能来帮助开发者更高效地管理API的整个生命周期。以下是Swagger的基本用法步骤：

1. 添加依赖

对于基于Spring Boot的项目，首先需要在pom.xml文件中添加Swagger的相关依赖。示例如下：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version> <!-- 请根据最新版本调整 -->
</dependency>

2. 配置Swagger

创建一个配置类来设置Swagger的基本信息，如标题、描述、版本等，并指定哪些包或接口需要被扫描。

import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

@Configuration
@EnableSwagger2WebMvc
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.any()) // 扫描所有包下的API
                .paths(PathSelectors.any()) // 所有路径
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("My API Documentation")
                .description("API description")
                .version("1.0.0")
                .contact(new Contact("Your Name", "https://yourwebsite.com", "your@email.com"))
                .license("Apache 2.0")
                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html")
                .build();
    }
}

3. 使用注解

在Controller类和方法上使用Swagger提供的注解来丰富API文档信息，例如：

• @Api: 用于类，说明该类的作用。
• @ApiOperation: 用于方法，描述方法的功能。
• @ApiParam: 用于方法参数，描述参数的含义。
• @ApiResponse: 用于方法，描述可能的响应信息。
• @ApiModel: 用于实体类，描述返回的对象模型。
• @ApiModelProperty: 用于实体类的字段，描述模型属性。

示例：

@Api(value = "用户管理", tags = "用户相关接口")
@RestController
@RequestMapping("/users")
public class UserController {

    @ApiOperation(value = "获取用户信息", notes = "根据id获取用户详细信息")
    @GetMapping("/{id}")
    public User getUser(@PathVariable Long id) {
        // 实现逻辑...
    }
}

4. 访问文档

启动应用后，通常可以通过 /swagger-ui.html 或 /swagger-ui/ 访问Swagger UI界面。在这里你可以查看API文档，尝试调用接口，并查看响应结果。

5. 自定义配置

Swagger提供了丰富的配置选项，如接口过滤、安全配置、自定义UI等，可以根据项目需求进一步定制。

以上就是Swagger的基本使用方法。随着项目的深入，你可能会用到更多高级特性，比如分组文档、安全认证、扩展插件等。