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数组
相关推荐
现在没有牛仔了12 天前
SpringBoot项目集成Swagger指南
spring boot·后端·swagger
百锦再25 天前
一文精通 Swagger 在 .NET 中的全方位配置与应用
后端·ui·.net·接口·配置·swagger·访问
杨DaB1 个月前
【SpringBoot】Swagger 接口工具
java·spring boot·后端·restful·swagger
lgx0406051121 个月前
基于.Net Framework4.5 Web API 引用Swagger
swagger·.net framework
IT之家2 个月前
swagger文档生成html静态文档
swagger·openapi·离线文档
小王子10242 个月前
Django集成Swagger全指南:两种实用方案详解
django·swagger·openapi
小王子10242 个月前
Django集成Swagger全指南:两种实现方案详解
django·swagger·openapi
发粪的屎壳郎2 个月前
ASP .NET Core 8集成Swagger全攻略
swagger·asp .net core
crud3 个月前
Spring Boot 整合 Smart-Doc:零注解生成 API 文档,告别 Swagger
java·spring boot·swagger
大千AI助手3 个月前
5分钟玩转Swagger UI:Docker部署+静态化实战
ui·docker·容器·swagger·swaggerui