Swagger接口管理文档

Visit the interface documentation web page:http://localhost:8080/swagger-ui/index.html

导入依赖

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>

编写yaml

SpringBoot 2.6以上版本修改了路径匹配规则,但是Swagger3还不支持,这里换回之前的,不然启动直接报错

spring:
mvc:
pathmatch:
matching-strategy: ant_path_matcher

创建配置类配置swagger信息

这个是配置swaggerLarge text for web pages

@Configuration
public class SwaggerConfiguration {
@Bean
public Docket docket() {
return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfoMyself())
.select() //Enable Select Scan Interface function
.apis(RequestHandlerSelectors.basePackage("com.example.controller")) //设置swaggerOnly the interfaces under this package are scanned(You can also set to scan only each class,某个方法)
.build();
} private ApiInfo apiInfoMyself(){
return new ApiInfoBuilder()
.contact(new Contact("你的名字", "https://www.bilibili.com", "javastudy111*@163.com"))
.title("system in the library——在线api接口文档")
.description("Welcome to the front-end bigwigs to visit the interface")
.version("1.1") //You can freely define the version of this interface
.build();
}
}

Add specific description

//为xxxcontrollerThis class is annotated
@Api(tags = "账户验证接口", description = "包括用户登录、注册、验证码请求等操作.")
@RestController
@RequestMapping("/api/auth")
public class AuthApiController { //Annotate an interface
@ApiResponses({
@ApiResponse(code = 200, message = "邮件发送成功"),
@ApiResponse(code = 500, message = "邮件发送失败") //不同返回状态码描述
})
@ApiOperation("请求邮件验证码") //接口描述
@GetMapping("/verify-code")
public RestBean<Void> verifyCode(@ApiParam("邮箱地址") @RequestParam("email") String email,//请求参数的描述
@ApiParam("邮箱地址") @RequestParam("email") String email){ //让swaggerEvery interface is ignored
@ApiIgnore //忽略此请求映射
@PostMapping("/login-success")
public RestBean<Void> loginSuccess(){
return new RestBean<>(200, "登陆成功");
} //Add a description to the entity class(Because sometimes an entity class is returned,So you need to tell the front-end staff what this entity class describes)
@Data
@ApiModel(description = "响应实体封装类")
@AllArgsConstructor
public class RestBean<T> { @ApiModelProperty("状态码")
int code;
@ApiModelProperty("状态码描述")
String reason;
@ApiModelProperty("数据实体")
T data; public RestBean(int code, String reason) {
this.code = code;
this.reason = reason;
}
}

If there are multiple environments configured,prodThe production environment does not need to be turned onswagger了

springfox:
documentation:
enabled: false

后端编写SwaggerMore related articles on the interface management documentation

  1. Asp.Net Core Api 使用SwaggerManage the installation and use of documentation tutorials

    I need to make one this week due to the needs of the companyApi的程序,I've been there for three days this weekCore Api和 framework Apitangled in between.Not sure which one to use for the project,After thinking about it, I decided.Since I have never used both, why not use it ...

  2. 基于.NetCore3.1搭建项目系列 —— 使用Swagger做Api文档 (上篇)

    前言 为什么在开发中,接口文档越来越成为前后端开发人员沟通的枢纽呢? 随着业务的发张,项目越来越多,而对于支撑整个项目架构体系而言,我们对系统业务的水平拆分,垂直分层,让业务系统更加清晰,从而产生一系 ...

  3. 使用swagger生成API文档

    Sometimes a clear interface document can greatly improve the communication efficiency and development efficiency between the front and back ends.本文将介绍如何使用swagger生成接口文档. swagger介绍 Swagger本质上是一种用于描述使用JSON表示的RES ...

  4. 【WebAPI No.4】Swagger实现API文档功能

    介绍: Swagger也称为Open API,Swagger从API文档中手动完成工作,并提供一系列用于生成,可视化和维护API文档的解决方案.简单的说就是一款让你更好的书写API文档的框架. 我们为 ...

  5. springboot+mybatis-puls利用swagger构建api文档

    项目开发常采用前后端分离的方式.前后端通过API进行交互,在Swagger UI中,前后端人员能够直观预览并且测试API,方便前后端人员同步开发. 在SpringBoot中集成swagger,步骤如下 ...

  6. Swagger实现API文档功能

    介绍: wagger也称为Open API,Swagger从API文档中手动完成工作,并提供一系列用于生成,可视化和维护API文档的解决方案.简单的说就是一款让你更好的书写API文档的框架. 我们为什 ...

  7. 【swagger】1.swagger提供开发者文档--简单集成到spring boot中【spring mvc】【spring boot】

    swagger提供开发者文档 ======================================================== 作用:想使用swagger的同学,一定是想用它来做前后台 ...

  8. springboot利用swagger构建api文档

    前言 Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件.本文简单介绍了在项目中集成swagger的方法和一些常见问题.如果想深入分析项目源码,了解更多内容,见参考资料. S ...

  9. .Net Core 3.1 WebApi使用Swagger生成Api文档

    用swagger生成Api文档 1.安装Swashbuckle.AspNetCore 右键单击"解决方案资源管理器" > "管理 NuGet 包"中的项目 ...

  10. 在ASP.NET Core Web API上使用Swagger提供API文档

    我在开发自己的博客系统(http://daxnet.me)时,给自己的RESTful服务增加了基于Swagger的API文档功能.当设置IISExpress的默认启动路由到Swagger的API文档页 ...

随机推荐

  1. Java提高篇——静态代码块、构造代码块、构造函数以及Java类初始化顺序

    静态代码块:用staitc声明,jvm加载类时执行,仅执行一次构造代码块:类中直接用{}定义,每一次创建对象时执行.执行顺序优先级:静态块,main(),构造块,构造方法. 构造函数 public H ...

  2. 用DartWritten for the game of Reversi

    2013年11月,Dart语言1.0稳定版SDK发布,普天同庆.从此,Web programming is no longer tangled. 在我看来,DartThe syntax is simply thatC#的升级版,太像了.之所以喜欢RubyAn important reason is supportmixin功能,而 ...

  3. Java简单类——一对多映射(省、市)

    class Province { private int pid ; private String name ; private City cities [] ; public Province (i ...

  4. linux 磁盘空间扩容 vg(+pv) lv(+空间) lv(缩减磁盘空间)

    preFace APP scenario description: 当你未能合理的规划存储时,在后期的维护工作中可能会涉及的存储的 再规划(eg,某一个 or 数个App 对某一个lv 即挂载点写Bi ...

  5. E. Gerald and Giant Chess

    E. Gerald and Giant Chess time limit per test 2 seconds memory limit per test 256 megabytes2015-09-0 ...

  6. C#中的垃圾回收机制与delegate

    在DeepStream的C#版本调试过程中,发现了一个问题,运行一段时间后,大概每次内存到16M(Debug模式)就会异常 错误“System.NullReferenceException:未将对象引 ...

  7. sleep与信号唤醒的问题 & 内核对信号的处理方式 & udelay

    http://www.cnblogs.com/charlesblc/p/6277848.html 注意,sleep是会被信号唤醒的.   sleep函数:#include <unistd.h&g ...

  8. Perforce-Server迁移

    Author: JinDate: 20140827System: Windows 2008 R2 从Windows 2008 R2迁移到Windows 2008 R2 linux版本迁移官方文档htt ...

  9. mysql 数据操作 多表查询 子查询 介绍

    子查询就是: 把一条sqlStatements are enclosed in parentheses,as anothersql语句查询条件使用 After getting this result be the nextsql语句查询条件mysql 数据操作  子查询 #1:A subquery is to nest one query statement within another ...

  10. Octotree Chrome安装与使用整理

    Octotree Chrome作用: Mainly keeps you ingithubWhen viewing the project, you can clearly see the structure of the project and the specific code,Make downloading code more purposeful,Reduce unnecessary code downloads,And it looks clearer. 效果图:(安装插件前) ...