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数组
相关推荐
wangmengxxw2 小时前
Swagger技术
java·swagger
猿与禅1 天前
SpringBoot 2.x 升级到 3.x 时 Swagger 迁移完整指南
swagger·springboot升级·springboot3.0·swagger3.0
東雪木5 天前
Spring Boot 2.x 集成 Knife4j (OpenAPI 3) 完整操作指南
java·spring boot·后端·swagger·knife4j·java异常处理
一念一花一世界6 天前
swagger和PostIn,开源免费接口管理工具选型指南
api·swagger·postin·接口管理工具
赵庆明老师14 天前
ASP.NET Core 9 Web Api 启用 Swagger
swagger·dotnet
一念一花一世界16 天前
Postman vs swagger vs PostIn,接口管理工具一文纵评
postman·swagger·postin·接口管理工具
咖啡Beans1 个月前
SpringBoot2.7集成Swagger3.0
java·swagger
靓仔建1 个月前
Asp.net core用Swashbuckle.AspNetCore库出现错误信息:No operations defined in spec!
后端·asp.net·swagger
whltaoin2 个月前
Spring Boot Swagger3常用注解详解与实战
spring boot·注解·swagger
现在没有牛仔了2 个月前
SpringBoot项目集成Swagger指南
spring boot·后端·swagger