springboot 配置swagger2

嘿！前后端分离开发的时候前端是不是觉得后端是死逼，接口开发成这鸟儿样还能用，关键是每次给的文档都不及时，马蛋字段加了也不说一声，如果有以上类似的情况，可以开始考虑使用swagger了。

springboot用起来就是爽，没错！一个字爽，简单的配置满足你的想象，在pom中加上下面的这些：

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

然后在入口文件中添加上一个注解就可以了：

package com.jinhetech.lottery;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication()
@EnableSwagger2
public class LotteryApplication {

    public static void main(String[] args) {
        SpringApplication.run(LotteryApplication.class, args);
    }
}

但是需要注意的是，如果你的项目发布了，不希望别人看到这些，是需要设置这些页面需要账号及密码才能访问，需要在application.properties文件中添加相关代码通过spring.security来控制页面需要账户密码才能访问，其中比较关键的是，需要将多个路径设置为安全访问的路径：

security.basic.path=/manager,/swagger-ui.html

相关注解
@Api：修饰整个类，描述Controller的作用
@ApiOperation：描述一个类的一个方法，或者说一个接口
@ApiParam：单个参数描述
@ApiModel：用对象来接收参数
@ApiProperty：用对象接收参数时，描述对象的一个字段
@ApiResponse：HTTP响应其中1个描述
@ApiResponses：HTTP响应整体描述
@ApiIgnore：使用该注解忽略这个API
@ApiError ：发生错误返回的信息
@ApiImplicitParam：一个请求参数
@ApiImplicitParams：多个请求参数
相关文档

https://www.cnblogs.com/fengli9998/p/7921601.html

上一页springboot 项目注意事项下一页使用 docker 发布springboot项目

最后更新于5年前