@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
相关推荐
柠檬苏打z5 天前
C# SwaggerLoginAuthPlugin 一款给Swagger文档加登录页面的小插件身如柳絮随风扬19 天前
Swagger 完全学习指南:从零到一搭建 API 文档自动化想不明白的过度思考者19 天前
一个叫Swagger的工具,让写接口文档变成享受曲幽1 个月前
FastAPI自动生成的API文档太丑?我花了一晚上把它改成了客户愿意付费的样子曲幽1 个月前
告别手写 API 胶水代码:FastAPI 与 Vue 的“契约自动机” OpenAPI 实战Zzxy1 个月前
Spring Boot集成Swagger/Knife4jI'm Jie2 个月前
Swagger UI 本地化部署,解决 FastAPI Swagger UI 依赖外部 CDN 加载失败问题Murphy20232 个月前
.net8 Swashbuckle.AspNetCore WEBAPI 配置要点记录一念一花一世界3 个月前
接口管理工具选型指南:Postman vs swagger vs PostIn没有bug.的程序员3 个月前
Spring Boot 与 Swagger:API 文档自动化生成、版本管理与云原生协作深度实战指南