@Api 用它标识的Controller称为一个模块
tag:标识模块名称
@ApiOperation 标识一个接口,会呈现在一个模块下
vlue: 标识接口名称
notes:放置接口备注
@ApiImplicitParam 标识接口的请求参数,即Controller方法的一个入参
name:参数名称
value:参数值提示,会在输入文本框placeholder、字段名下方显示
paramType*:重点!这个标识swagger接收的ajax参数应该对应到Java方法的哪里,类型如下:
query:指明一个参数接收query param参数(?a=1&b=2类型)
path: 指明一个参数接收路径参数
body:指明一个参数(DTO)接收ajax的request body数据,body通常是json数据。
header:指明一个参数从header中读取
form: 接收普通表单,不常用
dataType*:重点!指明这个方法入参的数据类型,为一个Java的类名,默认为String,示例:dataType="QueryCriteria"、dataType="FightDTO"
@ApiImplicitParams 标识多个请求参数,放置的是@ApiImplicitParam数组
swagger
xixiyuguang2023-11-09 13:26
相关推荐
csdn_aspnet17 天前
C# .NetCore Swagger ISchemaFilter 处理枚举、特殊类型csdn_aspnet17 天前
C# .NetCore Swagger ISchemaFilter Long 转 String 防精度丢失csdn_aspnet18 天前
C# .NetCore Swagger ISchemaFilter 注入示例值、描述信也科技布道师19 天前
把 Swagger 变成联调工作台:Swagger Pro 工程实践愛芳芳2 个月前
Swagger2 多环境动态配置实战指南正儿八经的少年2 个月前
javaDoc,swagger,springDoc 的作用和区别Murphy20233 个月前
.net10 WEB API项目中启用Swagger 页面的配置步骤逻极3 个月前
FastAPI 实战:从入门到自动化文档,如何把API开发效率提升200%qq_262642374 个月前
Swagger/Knife4j 下载文件损坏,但前端却能正常打开柠檬苏打z6 个月前
C# SwaggerLoginAuthPlugin 一款给Swagger文档加登录页面的小插件