swagger3 设置值可以为空_【Swagger2】【3】API注解详解，以及注解常用参数配置

前言：

@Api，@ApiOperation，@ApiImplicitParam，@ApiModelProperty，@ApiIgnore

正文：

一，Controller层

@ApiIgnore

@CrossOrigin(origins= "*")

@RestController

@Api(tags= {"文章接口"})public classArticleController {

@ApiIgnore

@ApiOperation(value= "文章详情")

@ApiImplicitParams({

@ApiImplicitParam(name= "id", value = "文章编号", required = true, dataType = "String", paramType = "query", example="12345"),

})

@RequestMapping(value= "article", method =RequestMethod.GET)public ResultgetArticleInfo(@ApiIgnore String id) {return this.theService.getArticleInfo(id);

}

@Api：作用在类上，用来标注该类具体实现内容。

参数：

1，tags：该类的名称

2，description：描述该类的作用

@ApiOperation：表示一个http请求的操作

参数：

1，value ：接口名称

@ApiImplicitParam：接口的单个请求参数，根据需要选择

参数：

1，name ：参数名

2，value ：描述参数名

3，required ：该参数是否必填

4，dataType ：参数的数据类型

4，example：举例

6， paramType ：查询参数类型。这里有几种形式：

类型

作用

path

以地址的形式提交数据

query

直接跟参数完成自动映射赋值

body

以流的形式提交仅支持POST

header

参数在request headers 里边提交

form

以form表单的形式提交仅支持POST

@ApiIgnore

表示忽略该方法、类、参数，不显示在swagger-ui.html上

二，如果传入的参数是用实体类接收的

public classAddVo {

@ApiModelProperty(name="province", value="所在省", required=true)privateString province;

@ApiModelProperty(name="city", value="所在市", required=true)privateString city;

}

@ApiModelProperty：同@ApiImplicitParam一致

参考博客：

@ApiIgnore 注解的用法

swagger3 设置值可以为空_【Swagger2】【3】API注解详解，以及注解常用参数配置相关推荐

idea看java版本设置_详解IntelliJ IDEA 中如何配置多个jdk版本即(1.7和1.8两个jdk都可用)...
详解IntelliJ IDEA 中如何配置多个jdk版本即(1.7和1.8两个jdk都可用) 有时候需要看Java源码,但是 Java 1.7 和 Java 1.8的差别的关系,有时候你想查看不同jd ...
数学建模_随机森林分类模型详解Python代码
数学建模_随机森林分类模型详解Python代码随机森林需要调整的参数有: (1) 决策树的个数 (2) 特征属性的个数 (3) 递归次数(即决策树的深度)''' from numpy import ...
java注解源码_详解Java注解教程及自定义注解
详解Java注解教程及自定义注解更新时间:2016-02-26 11:47:06 作者:佚名我要评论(0) Java注解提供了关于代码的一些信息,但并不直接作用于它所注解的代码内容.在这个 ...
html注册验证radio,html中radio值的获取、赋值、注册事件示例详解分享
1,radio分组只要name一样,就是一组的,即一组中只能选择一个,如下: 复制代码代码如下: group1: radio1 radio2 radio3 group2: radio4 radio5 ...
KNN（K Nearest Neighbors）分类是什么学习方法？如何或者最佳的K值？RadiusneighborsClassifer分类器又是什么？KNN进行分类详解及实践
KNN(K Nearest Neighbors)分类是什么学习方法?如何或者最佳的K值?RadiusneighborsClassifer分类器又是什么?KNN进行分类详解及实践如何使用GridSea ...
python函数中可变参数的传递方式是_详解Python函数可变参数定义及其参数传递方式...
Python函数可变参数定义及其参数传递方式详解 python中函数不定参数的定义形式如下 1. func(*args) 传入的参数为以元组形式存在args中,如: def func(*args): ...
java的注解方式_详解Java注解的实现与使用方法
详解Java注解的实现与使用方法 Java注解是java5版本发布的,其作用就是节省配置文件,增强代码可读性.在如今各种框架及开发中非常常见,特此说明一下. 如何创建一个注解每一个自定义的注解都由四 ...
java虚拟机工作原理图_超“强”的图文详解-JVM虚拟机底层原理与调优实战
今天我和大家分享一篇文章,文章上半部分为JVM底层原理下半部分为调优实战文章有点长,需要点耐心哦! 如果觉得看文章太难理解,就点击下面我投稿B站的jvm视频讲解. 还配有视频讲解:解密BATJ一线 ...
Python中下划线 _ 的最全用法详解
Python中下划线 _ 的最全用法详解 '_'是什么? _在python中可以作为一个标识符,用于定义变量和方法唯一名称.同时它也是Python中的一个软关键字,指在某些特定上下文中保留的关键字.截 ...

swagger3 设置值可以为空_【Swagger2】【3】API注解详解，以及注解常用参数配置

swagger3 设置值可以为空_【Swagger2】【3】API注解详解，以及注解常用参数配置相关推荐

最新文章

热门文章