Swagger3 学习笔记

技术Swagger3 学习笔记 Swagger3 学习笔记Swagger3
准备
dependencygroupIdio.springfox/groupIdartifactIdspringfox-boo

赃物3学习笔记

Swagger3

准备

属国

groupIdio.springfox/groupId

artifactIdspringfox-boot-starter/artifactId

版本3 .0 .0/版本

/依赖性

@EnableOpenApi

常用注解

注解

方法

属性

@Api(标签)

标注一个类为时髦的资源,设置资源名称,默认是类名

@ApiOperation(值)

标注一个请求,设置该请求的名称,默认是方法名

@ Apipparam

(不常用)仅用于JAX-RS

@ApiImplicitParam

(常用)功能同@ ApiParame,可用于小型应用程序

@ APIimplicationparams

包裹多个参数描述注解

@ ApiModel

标注一个实体类

@ApiModelProperty

标注实体属性,设置属性的备注信息

@ApiResponse

描述响应码,以及备注信息

@ApiResponses

包裹多个响应描述注解

@ApiIgnore

使时髦的忽略某个资源

使时髦的忽略某个接口

使时髦的忽略某个属性

配置文档信息

@配置

公共类SwaggerConfig {

@豆

公共Docket Docket(){ 0

返回新的文件类型.美洲国家组织_30)。组名(' learnswager ')。apiInfo(apiInfo())。使能(真);

}

私有ApiInfo ApiInfo(){ 0

返回新的ApiInfoBuilder()。标题('测试文档标题)。联系人(新联系人(' XTvLi ',' https://github.com/xtyuns ',null))。描述('测试文档描述信息)。版本(' v1.0.0 ')。build();

}

}

详见摘要和ApiInfo的源码

文档资源过滤

@豆

公共Docket Docket(){ 0

返回新的文件类型.美洲国家组织_30)。组名(' learnswager ')。选择()。路径(s - s.startsWith('/v1 ')。build();

}

通过小路选取时可以使用路径选择器,其中提供了any()、none()、ant(antPattern)、regex(pathRegex)方法。

@豆

公共Docket Docket(){ 0

返回新的文件类型.美洲国家组织_30)。组名(' learnswager ')。选择()。API(RequestHandlerSelectors。BasePackage(' com。xtyuns ')。API(RequestHandler-)索引-控制器")。equals(RequestHandler。GroupName()))。build();

}

//等同于(使用和连结多个选取方法)

@豆

公共Docket Docket(){ 0

返回新的文件类型.美洲国家组织_30)。组名(' learnswager ')。选择()。API(

requestehandlerselectors。基本包(' com。xtyuns ')。和(

requestHandler -”索引控制器"。equals(RequestHandler。GroupName())

)

).build();

}

//默认的选择器

公共静态最终ApiSelector DEFAULT

=新的ApiSelector(

(带类注释)。求反())。和(

(带有方法注释(API忽略。类).求反())、路径选择器。any());

requestehandlerselectors中也提供了any()、none()、withClassAnnotation(cls)、withMethodAnnotation(cls)方法。

requestHandler.groupName()是类名称的中划线表示法,RequestHandler类中还有一些其他信息可用于进行断言。

文档分组

可以配置多个Docket Bean,必须使用GroupName进行区分。

内容来源网络,如有侵权,联系删除,本文地址:https://www.230890.com/zhan/141439.html

(0)

相关推荐

  • c语言socket编程流程(c语言socket编程怎么实现)

    技术如何使用C语言实现本地socke通讯这篇文章主要介绍了如何使用C语言实现本地socke通讯,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。一、概述  使

    攻略 2021年12月20日
  • 早餐的重要性,每天吃早餐对健康有什么意义

    技术早餐的重要性,每天吃早餐对健康有什么意义谢邀请早餐的重要性!吃早餐对人的健康是非常重要的。早餐不仅要吃,而且还要吃的好,吃的有营养。人经过晚饭后十几个小时的能量消耗,所剩的热能几乎没有了,若早饭不能及时补充,会直接影

    生活 2021年10月22日
  • 树莓派如何连接WPA2企业级802.1X保护WIFI

    技术树莓派如何连接WPA2企业级802.1X保护WIFI树莓派如何连接WPA2企业级802.1X保护WIFI,相信很多没有经验的人对此束手无策,为此本文总结了问题出现的原因和解决方法,通过这篇文章希望你能解决这个问题。让

    攻略 2021年11月19日
  • mysql与sql的区别有哪些

    技术mysql与sql的区别有哪些这篇文章给大家分享的是有关mysql与sql的区别有哪些的内容。小编觉得挺实用的,因此分享给大家做个参考,一起跟随小编过来看看吧。 mysql与sql的区别是

    攻略 2021年12月2日
  • JVM堆内存溢出后其他线程是否可继续工作

    技术JVM堆内存溢出后其他线程是否可继续工作本篇文章给大家分享的是有关JVM堆内存溢出后其他线程是否可继续工作,小编觉得挺实用的,因此分享给大家学习,希望大家阅读完这篇文章后可以有所收获,话不多说,跟着小编一起来看看吧。

    2021年10月23日
  • KindEditor

    技术KindEditor KindEditor - 支持word上传的富文本编辑器?
    图片的复制无非有两种方法,一种是图片直接上传到服务器,另外一种转换成二进制流的base64码
    目前限chrome浏览

    礼包 2021年11月25日