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)

相关推荐
心之语歌2 分钟前
Java高效压缩技巧:ZipOutputStream详解
java·后端
booooooty5 分钟前
基于Spring AI Alibaba的多智能体RAG应用
java·人工智能·spring·多智能体·rag·spring ai·ai alibaba
猴哥源码6 分钟前
基于Java+SpringBoot的健身房管理系统
java·spring boot
极光雨雨11 分钟前
Spring Bean 控制销毁顺序的方法总结
java·spring
猴哥源码15 分钟前
基于Java+SpringBoot的三国之家网站
java·spring boot
念九_ysl29 分钟前
Java 使用 OpenHTMLToPDF + Batik 将含 SVG 遮罩的 HTML 转为 PDF 的完整实践
java·开发语言·pdf
yaoxin52112339 分钟前
124. Java 泛型 - 有界类型参数
java·开发语言
Spirit_NKlaus41 分钟前
解决HttpServletRequest无法获取@RequestBody修饰的参数
java·spring boot·spring
不死的精灵1 小时前
【Java21】在spring boot中使用ScopedValue
java·spring boot·后端
勤奋的知更鸟1 小时前
Java 编程之模板方法模式
java·开发语言·模板方法模式