swagger

复制代码
@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数组
相关推荐
crud25 天前
Spring Boot 整合 Smart-Doc:零注解生成 API 文档,告别 Swagger
java·spring boot·swagger
大千AI助手25 天前
5分钟玩转Swagger UI:Docker部署+静态化实战
ui·docker·容器·swagger·swaggerui
crud1 个月前
Spring Boot 3 整合 Swagger:打造现代化 API 文档系统(附完整代码 + 高级配置 + 最佳实践)
java·spring boot·swagger
掘金詹姆斯2 个月前
在线接口调试工具-swagger
java·swagger
小巫程序Demo日记3 个月前
自问自答模式(Operation是什么)
swagger
孟陬4 个月前
swaggered CLI:swagger json schema 转成 TS 代码
typescript·swagger
csdn_aspnet4 个月前
Swagger 从 .NET 9 中删除:有哪些替代方案
swagger·openapi·.net9
喵个咪5 个月前
开箱即用的GO后台管理系统 Kratos Admin - 交互式API文档 Swagger UI
后端·go·swagger
西京刀客5 个月前
golang常用库之-swaggo/swag根据注释生成接口文档
golang·swagger·swag
梦想画家5 个月前
Golang Gin系列-9:Gin 集成Swagger生成文档
golang·gin·swagger