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)

相关推荐
武子康39 分钟前
大数据-98 Spark 从 DStream 到 Structured Streaming:Spark 实时计算的演进
大数据·后端·spark
该用户已不存在1 小时前
6个值得收藏的.NET ORM 框架
前端·后端·.net
文心快码BaiduComate1 小时前
文心快码入选2025服贸会“数智影响力”先锋案例
前端·后端·程序员
neoooo1 小时前
🌐 Cloudflare Tunnel vs ZeroTier:两个世界的内网穿透哲学
后端
卡尔特斯1 小时前
Android Kotlin 项目代理配置【详细步骤(可选)】
android·java·kotlin
白鲸开源1 小时前
Ubuntu 22 下 DolphinScheduler 3.x 伪集群部署实录
java·ubuntu·开源
涡能增压发动积1 小时前
当你不了解“异步”时请慎用“异步”——记一次生产环境故障排查之旅
后端
文心快码BaiduComate1 小时前
用Comate Zulu开发一款微信小程序
前端·后端·微信小程序
用户8356290780511 小时前
Python 删除 Excel 工作表中的空白行列
后端·python
Json_1 小时前
使用python-fastApi框架开发一个学校宿舍管理系统-前后端分离项目
后端·python·fastapi