Swagger使用手册

什么是Swagger？

Swagger是一个用于设计、构建和文档化RESTful Web服务的开源框架。它提供了一种简洁、可读性强的方式来描述API的结构和功能，并生成交互式的API文档。

如何使用？

1. 引入相关依赖。

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-boot-starter</artifactId>
        <version>3.0.0</version>
    </dependency>
</dependencies>

2. 创建配置类

@Configuration
@EnableOpenApi
public class SwaggerConfig {

    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo()).enable(true)
                .select()
                //apis： 添加swagger接口提取范围
                .apis(RequestHandlerSelectors.basePackage("com.chenzhuowen.swaggerspringbootstudy.controller"))
                //.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("XX项目接口文档")
                .description("XX项目描述")
                .contact(new Contact("作者", "作者URL", "作者Email"))
                .version("1.0")
                .build();
    }
}

3. 在Controller类添加swagger注解

@RestController
@Api(tags = "Example API")
public class SwaggerExampleController {

    @ApiOperation("Say Hello")
    @GetMapping("/helloWorld")
    public String helloWorld() {
        return "hello world";
    }
}

4. 启动应用，访问http://127.0.0.1:7101/swagger-ui/index.html，登录swagger控制台。

knife4j

Knife4j（原称Swagger-Bootstrap-UI）是一个基于Swagger的Java接口文档生成工具，它可以帮助开发人员生成并展示API接口文档。Swagger是一种用于描述、生成、消费和可视化RESTful风格的API文档的工具，而Knife4j在此基础上进行了增强和定制，以提供更好的用户体验和功能。