swagger默认值（swagger怎么配置）



swagger 是一系列 restful api 的工具，通过 swagger 可以获得项目的⼀种交互式文档，客户端 sdk 的自动生成等功能。

Swagger 的目标是为 REST APIs 定义一个标准的、与语⾔言无关的接口，使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下，能发现和理解各种服务的功能。当服务通过 Swagger 定义，消费者就能与远程的服务互动通过少量的实现逻辑。

使用 Spring Boot 集成 Swagger 的理念是，使用用注解来标记出需要在 API 文档中展示的信息，Swagger 会根据项目中标记的注解来生成对应的 API 文档。Swagger 被号称世界上最流行的 API 工具，它提供了 API 管理的全套解决方案，API 文档管理需要考虑的因素基本都包含，这里将讲解最常用的定制内容。

1、添加swagger坐标

Spring Boot 集成 Swagger 3 很简单，需要引入依赖并做基础配置即可。

2、Swagger Helloword 实现

2.1、创建springboot项目

在启动类上加上@EnableOpenApi 注解 启用swagger api文档功能

2.2、写一个接口

2.3、访问地址

Swagger 通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息等

1、Api 注解和 ApiOperation 注解

使用在类上，表明是swagger资源，@API拥有两个属性:value、tags。

生成的api文档会根据tags分类，直白的说就是这个controller中的所有接口生成的接口文档都会在tags这个list下；tags如果有多个值，会生成多个list，每个list都显示所有接口

value的作用类似tags,但是不能有多个值

使用于在方法上，表示一个http请求的操作

案例：使用@Api和@ApiOperation生成api文档

2、ApiImplicitParams 注解和 ApiImplicitParam

@ApiImplicitParams 注解和 @ApiImplicitParam 用于对方法中的非对象参数(参数绑定到简单类型时使用。)进行说明

注意：@ApiImplicitParam 的 name 属性要和 @RequestParam 或 @PathVariable 的 value 遥相呼应。

案例：使用@ApiImplicitParams注解和 @ApiImplicitParam 对方法参数进行说明

3、ApiModel注解和 ApiModelProperty

4、ApiResponse 和 ApiResponses

@ApiResponses 注解和 @ApiResponse 标注在 Controller 的方法上，用来描述 HTTP 请求的响应

5、创建 SwaggerConfig 配置类

在 SwaggerConfig 中添加两个方法：（其中一个方法是为另一个方法作辅助的准备工作）

api()方法使用 @Bean，在启动时初始化，返回实例 Docket（Swagger API 摘要对象），这里需要注意的是 .apis(RequestHandlerSelectors.basePackage("xxx.yyy.zzz")) 指定需要扫描的包路路径，只有此路径下的 Controller 类才会自动生成 Swagger API 文档。

apiInfo()方法配置相对重要一些，主要配置页面展示的基本信息包括，标题、描述、版本、服务条款等，查看 ApiInfo 类的源码还会发现支持 license 等更多的配置

4.1，配置放行的地址

4.2，替换UI

上面的整个过程已经完成了，但是生成的接口文档的页面，其实很多人不太喜欢，觉得不太符合国人的使用习惯，所有又有一些大神，提供了其他的UI测试页面。这个页面的使用还是比较广泛的。

导入以下依赖、重启工程后访问地址：http://localhost:8080/doc.html

以上就是SpringBoot整合接口管理工具Swagger怎么使用的详细内容，更多请关注php中文网其它相关文章！

版权声明：

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如若内容造成侵权、违法违规、事实不符，请将相关资料发送至xkadmin@xkablog.com进行投诉反馈，一经查实，立即处理！

转载请注明出处，原文链接：https://www.xkablog.com/rfx/29868.html