SpringBoot 配置 Swagger 实现接口文档自动生成

Swagger2简介

通常在前后端开发中,为了减少一些沟通成本,一般都会构建一份 RESTful API 文档来描述所有的接口信息
Swagger 2 是一个开源软件框架,可以帮助开发人员设计、构建、记录和使用 RESTful Web 服务,它将代码和文档融为一体,

1. 整合 Spring Boot

首先创建 Spring Boot Web 项目,添加 Swagger 2 的相关依赖,代码如下:

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

        <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. 创建 Swagger 2 的配置类

首先通过@EnableSwagger2注解开启 Swagger2
然后在通过 apis 这个方法配置要扫描的 controller 位置,通过 paths 方法配置路径
在 apiInfo 中构建文档的基本信息,比如描述、联系人信息、版本、标题等等

@Configuration
@EnableSwagger2 //此注解表示开启 Swagger 2
public class SwaggerConfig {
    @Bean
    Docket docket() {
        return new Docket(DocumentationType.S
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值