@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
相关推荐
闲人编程3 天前
OpenAPI/Swagger规范与API文档自动化一念一花一世界4 天前
接口管理工具选型:Swagger与PostIn全面对比指南一念一花一世界4 天前
接口管理工具选型:Postman、Swagger与PostIn的全面对比指南西部森林牧歌18 天前
Postman、swagger、PostIn接口管理工具详细纵评西部森林牧歌19 天前
接口管理工具选型指南:swagger与PostIn深度对比wangmengxxw21 天前
Swagger技术猿与禅22 天前
SpringBoot 2.x 升级到 3.x 时 Swagger 迁移完整指南東雪木1 个月前
Spring Boot 2.x 集成 Knife4j (OpenAPI 3) 完整操作指南一念一花一世界1 个月前
swagger和PostIn,开源免费接口管理工具选型指南赵庆明老师1 个月前
ASP.NET Core 9 Web Api 启用 Swagger