zoukankan      html  css  js  c++  java
  • Swagger 注解

    Swagger 常用注解介绍:

    》》》在控制类上:

    @Api: 标记在控制器类上

    value: 控制器类名称

    tags: 控制器类标签

    @ApiOperation: 标记在映射方法上

    value: 接口说明,展示在接口列表

    notes:接口详细说明,展示在接口的详情页。

    tags:接口的标签,相同标签的接口会在一个标签页下展示。

    httpMethod:支持的HTTP的方法。

    @ApiImplicitParam: 请求参数属性配置

    name:参数名称

    value:参数说明

    required:是否必须

    dataType:数据类型

    注意@ApiImplicitParams@ApiImplicitParam的容器,通过@ApiImplicitParam可以配置请求参数个各自的属性,但是若请求参数是一个实体对象,@ApiImplicitParam也可以直接指向对象(dataType=@ApiModel的value值),然后在实体对象中对字段进行限定

    》》》在实体类上:

    @ApiModel:是对整个类的属性的配置:

    value:类的说明

    description:详细描述

    @ApiModelProperty:是对具体每个字段的属性配置:

    name:字段名称

    value:字段的说明

    required:是否必须

    example:示例值

    hidden:是否显示

  • 相关阅读:
    SQL优化
    Mybatis
    Spring MVC(总结二)
    ES多机集群配置
    ES索引,分片,一致性
    ElasticSearch关于索引库的命令操作
    试题01(一)
    Linux安装配置elastic search
    Windows安装配置elastic search
    SpringBoot(二)
  • 原文地址:https://www.cnblogs.com/xiaofanblog/p/11430267.html
Copyright © 2011-2022 走看看