SpringBoot-7. 使用Swagger构建文档

最新推荐文章于 2024-05-04 01:00:41 发布

--- ZYZ ---

最新推荐文章于 2024-05-04 01:00:41 发布

阅读量149

点赞数

分类专栏： SpringBoot 文章标签： Swagger

本文链接：https://blog.csdn.net/qq_35076330/article/details/99979144

版权

SpringBoot 专栏收录该内容

4 篇文章 0 订阅

订阅专栏

swagger可以降低我们前后端开发文档同步问题，其能够根据我们的代码注释自动生成API文档，而我们只需简单的运用其注释即可，可视化的呈现程序所有的接口列表，非常方便我们前后端进行接口调试。

The Best APIs are Built with Swagger Tools

Swagger工具可以帮助您完成生成和维护API文档的工作，确保您的文档在API发展过程中保持最新状态。

1. 添加Swagger依赖

<!-- 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>

2. 新建SwaggerConfig类

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfo(
                "Spring Boot Swagger Test",
                "我的博客网站：https://zyz-1998.github.io/，欢迎大家访问。",
                "API V1.0",
                "Terms of service",
                new Contact("zyz", "https://zyz-1998.github.io/", "1744020412@qq.com"),
                "Apache", "http://www.apache.org/", Collections.emptyList());
    }
}

3. 添加文档内容

用于Controller(控制类)

注解	作用
@Api	表示一个开放的API
@ApiOperation	给API增加说明，表示针对该API的CRUD操作
@ApiResponses	描述API操作可能出现的异常情况
@ApiImplicitParams`、`@ApiImplicitParam	给API参数增加说明。

用于model(实体类)