SpringBoot配置Swagger

可以在项目中创建SwaggerConfig,进行配置文档内容

1、配置基本信息

Docket:摘要对象,通过对象配置描述文件的信息。

apiInfo:设置描述文件中info。参数类型ApiInfo

select():返回ApiSelectorBuilder对象,通过对象调用build()可以创建Docket对象。

ApiInfoBuilder: ApiInfo 构建器。

public class SwaggerConfig {

@Bean

public Docket getDocket() {

return new Docket(DocumentationType_SWAGGER_2)

.apiInfo(swaggerDemoApiInfo())

.select()

.build();

}

public ApiInfo swaggerDemoApiInfo(){

return new ApiInfoBuilder()

.contact(new Contact("五道口职业技术学院", "http://wdk.com","xxx@qq.com"))

//文档标题

.title("这里是Swagger的标题")

//文档描述

.description("这里是Swagger的描述")

//文档版本

.version("1.0.0")

.build();

}

}

2、如何让SwaggerConfig 区分文档

@Api(tags = {"MyController"}, description = "用户登录控制器")

public class MyController {

//登陆操作

@PostMapping("/login")

public boolean login(String uname, String pwd){

return true;

}

@PostMapping("/save")

public boolean save(String uname, String pwd) {

}

}
@Api(tags = {"MyController"}, description = "用户访问控制器")

public class MyController2 {

//登陆操作

@PostMapping("/login")

public boolean login(String uname, String pwd){

return true;

}

@PostMapping("/save")

public boolean save(String uname, String pwd) {

}

}
2、ApiOperation

@ApiOperation 写在方法上,对方法进行总体描述

● value: 接口描述

● notes: 提示信息

代码示例:

@ApiOperation(value = "接口描述", notes="接口提示信息")
ApiParam

@Apiparam 写在方法参数前面。 用于对参数进行描述或说明是否为必添项等说明。

● name: 参数名称

● value: 参数描述

● required: 是否是必须

public People getPeople(Integer id, @ApiParam(value="姓名", required = true) String name, String address)

相关推荐
木心爱编程几秒前
C++20多线程新特性:更安全高效的并发编程
java·jvm·c++20
ljf8838几秒前
Java导出复杂excel,自定义excel导出
java·开发语言·excel
江流月照9 分钟前
PCIE地址空间介绍
java·服务器·网络
程序员爱钓鱼14 分钟前
Go语言实战案例 — 工具开发篇:编写一个进程监控工具
后端·google·go
一只乔哇噻39 分钟前
java后端工程师进修ing(研一版‖day44)
java·开发语言·学习·算法
老华带你飞1 小时前
畅阅读小程序|畅阅读系统|基于java的畅阅读系统小程序设计与实现(源码+数据库+文档)
java·数据库·vue.js·spring boot·小程序·毕设·畅阅读系统小程序
canonical_entropy1 小时前
不同的工作需要不同人格的AI大模型?
人工智能·后端·ai编程
IT_陈寒1 小时前
Vite 5.0 终极优化指南:7个配置技巧让你的构建速度提升200%
前端·人工智能·后端
小熊学Java1 小时前
基于 Spring Boot+Vue 的高校竞赛管理平台
vue.js·spring boot·后端
卓码软件测评4 小时前
第三方软件测试机构【性能测试工具用LoadRunner还是JMeter?】
java·功能测试·测试工具·jmeter·性能优化