• swagger常用注解


    @Api:修饰整个类,描述Controller的作用

    @ApiOperation:描述一个类的一个方法,或者说一个接口

    @ApiParam:单个参数描述

    @ApiModel:用对象来接收参数

    @ApiModelProperty:用对象接收参数时,描述对象的一个字段

    @ApiResponse:HTTP响应其中1个描述 @ApiResponses:HTTP响应整体描述 @ApiIgnore:使用

    该注解忽略这个API @ApiError :发生错误返回的信息 @ApiImplicitParam:一个请求参数

    @ApiImplicitParams:多个请求参数

    @ApiImplicitParam属性:

    @Api(value="cms页面管理接口",description = "cms页面管理接口,提供页面的增、删、改、查")
    public interface CmsPageControllerApi {
    @ApiOperation("分页查询页面列表")
    @ApiImplicitParams({
    @ApiImplicitParam(name="page",value = "页
    码",required=true,paramType="path",dataType="int"),
    @ApiImplicitParam(name="size",value = "每页记录
    数",required=true,paramType="path",dataType="int")
    })
    public QueryResponseResult findList(int page, int size, QueryPageRequest queryPageRequest) ;
    }
  • 相关阅读:
    java要注意的问题1
    广义表(线性表的推广)
    java基本类型和包装器类
    面试题10:斐波那契数列
    面试题9:用两个栈实现队列
    面试题8:二叉树的下一个结点
    10 分组数据
    9 汇总数据
    8 使用数据处理函数
    7 创建计算字段
  • 原文地址:https://www.cnblogs.com/yintingting/p/8892782.html
Copyright © 2020-2023  润新知