swagger生成API文档

介绍

简介

Swagger是一款目前世界最流行的API管理工具。目前Swagger已经形成一个生态圈，能够管理API的整个生命周期，从设计、文档到测试与部署。Swagger有几个重要特性：

• 代码侵入式注解
• 遵循YAML文档格式
• 非常适合三端（PC、iOS及Android）的API管理，尤其适合前后端完全分离的架构模式。
• 减少没有必要的文档，符合敏捷开发理念
• 功能强大

作用

• 接口的文档在线自动生成
• 功能测试

优点

1. 大大减少前后端的沟通
2. 方便查找和测试接口
3. 提高团队的开发效率
4. 方便新人了解项目

Spring Boot下使用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>

• 配置类

package com.hsp.config;

import org.springframework.context.annotation.Bean;
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;

/**
 * @Author 何世鹏
 * @Date 2021/2/19 20:18
 */
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //扫描的路径
                .apis(RequestHandlerSelectors.basePackage("com.hsp"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("文档名称")
                .description("文档介绍")
                .version("version 1.0")
                .build();
    }
}

到这里写的所以controller就都可以自动生成接口了
访问地址：http://localhost:8080/swagger-ui.html#

启动类要加@EnableSwagger2，否则会出问题

import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author 何世鹏
 */
@SpringBootApplication
@EnableSwagger2
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

常用注解