Spring Boot配置Swagger2生成API接口文档

最新推荐文章于 2022-05-12 19:49:00 发布

原创最新推荐文章于 2022-05-12 19:49:00 发布 · 285 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#spring #spring boot #前后端分离

SpringBoot 专栏收录该内容

34 篇文章

订阅专栏

本文介绍了如何使用Swagger2为Web服务生成RESTful风格的API文档。包括Swagger2的基本概念、配置步骤以及常用注解的使用方法。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Swagger2生成API接口文档

一、Swagger2介绍
二、配置Swagger2

一、Swagger2介绍

前后端分离开发模式中，api文档是最好的沟通方式

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

及时性 (接口变更后，能够及时准确地通知相关前后端开发人员)
规范性 (并且保证接口的规范性，如接口的地址，请求方式，参数及响应格式和错误信息)
一致性 (接口信息一致，不会出现因开发人员拿到的文档版本不一致，而出现分歧)
可测性 (直接在接口文档上进行测试，以方便理解业务)

访问Swagger
浏览器输入
http://localhost:项目端口号/swagger-ui.html

二、配置Swagger2

2.1 引入pom依赖

主要关注下边swagger的依赖

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <scope>provided </scope>
        </dependency>

        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <scope>provided </scope>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <scope>provided </scope>
        </dependency>
    </dependencies>

2.2 创建swagger的配置类

创建包config，创建类SwaggerConfig

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket webApiConfig(){

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")  //可根据自己情况修改
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();

    }
    
    private ApiInfo webApiInfo(){

        return new ApiInfoBuilder()
                .title("网站API文档")  //可根据自己情况修改：文档的主题
                .description("本文档描述了*******")  //可根据自己情况修改：介绍本文档
                .version("1.0")  //可根据自己情况修改
                .contact(new Contact("Dito", "http://iharbour.com", "*******@qq.com"))  //可根据自己情况修改自己的姓名，网站、邮箱
                .build();
    }
}

2.3 API模型：常用注解

实体类@ApiModelProperty

在属性上加上@ApiModelProperty可以定义样例数据。

@ApiModelProperty(value = "创建时间", example = "2019-01-01 8:00:00")
@TableField(fill = FieldFill.INSERT)
private Date gmtCreate;

@ApiModelProperty(value = "更新时间", example = "2019-01-01 8:00:00")
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date gmtModified;

Controller的注解@Api 、@ApiOperation、@ApiParam

@Api 定义在类上
@ApiOperation 定义在方法上
@ApiParam 定义在参数上

@Api(description="讲师管理")
@RestController
@RequestMapping("/admin/edu/teacher")
public class TeacherAdminController {

	@Autowired
	private TeacherService teacherService;

	@ApiOperation(value = "所有讲师列表")
	@GetMapping
	public List<Teacher> list(){
		return teacherService.list(null);
	}

	@ApiOperation(value = "根据ID删除讲师")
	@DeleteMapping("{id}")
	public boolean removeById(
			@ApiParam(name = "id", value = "讲师ID", required = true)
			@PathVariable String id){
		return teacherService.removeById(id);
	}
}

总的来说，swagger就是提供了上述注解（只列举了常用的几个），加上那些注解后，可以通过项目的端口（http://localhost:项目端口号/swagger-ui.html）在浏览器上访问项目提供的API，方便前后端的分离和测试。