swagger 返回值（swagger返回值注解）



1. swagger2简介

2. Springfox

3. swagger2极致用法

4. swagger-UI使用

5. swagger2配置

6. swagger2常用注解

1前言

接口文档对于前后端开发人员都十分重要。尤其近几年流行前后端分离后接口文档又变成重中之重。接口文档固然重要，但是由于项目周期等原因后端人员经常出现无法及时更新，导致前端人员抱怨接口文档和实际情况不一致。

想要了解、学习更多，请点击：https://www.bilibili.com/video/BV1YK4y1S7pw

很多人员会抱怨别人写的接口文档不规范，不及时更新。但是当自己写的时候确实最烦去写接口文档。这种痛苦只有亲身经历才会牢记于心。

如果接口文档可以实时动态生成就不会出现上面问题。

swagger可以完美的解决上面的问题。

想要了解、学习更多，请点击：https://www.bilibili.com/video/BV1YK4y1S7pw

2Open API 是什么

Open API规范(OpenAPI Specification)以前叫做swagger规范，是REST API的API描述格式。

Open API文件允许描述整个API，包括：

每个访问地址的类型。POST或GET。

每个操作的参数。包括输入输出参数。

认证方法。

连接信息，声明，使用团队和其他信息。

Open API规范可以使用YAML或JSON格式进行编写。这样更利于我们和机器进行阅读。

想要了解、学习更多，请点击：https://www.bilibili.com/video/BV1YK4y1S7pw

OpenAPI规范（OAS）为REST API定义了一个与语言无关的标准接口，允许人和计算机发现和理解服务的功能，而无需访问源代码，文档或通过网络流量检查。正确定义后，消费者可以使用最少量的实现逻辑来理解远程服务并与之交互。

然后，文档生成工具可以使用OpenAPI定义来显示API，使用各种编程语言生成服务器和客户端的代码生成工具，测试工具以及许多其他用例。

源码和说明参照：

swagger是一套围绕Open API规范构建的开源工具，可以帮助设计，构建，记录和使用REST API。

swagger工具包括的组件：

swagger Editor ：基于浏览器编辑器，可以在里面编写Open API规范。类似Markdown具有实时预览描述文件的功能。

swagger UI：将Open API规范呈现为交互式API文档。用可视化UI展示描述文件。

swagger Codegen：将OpenAPI规范生成为服务器存根和客户端库。通过swagger Codegen可以将描述文件生成html格式和cwiki形式的接口文档，同时也可以生成多种言语的客户端和服务端代码。

swagger Inspector：和swagger UI有点类似，但是可以返回更多信息，也会保存请求的实际参数数据。

想要了解、学习更多，请点击：https://www.bilibili.com/video/BV1YK4y1S7pw

swagger Hub：集成了上面所有项目的各个功能，你可以以项目和版本为单位，将你的描述文件上传到swagger Hub中。在swagger Hub中可以完成上面项目的所有工作，需要注册账号，分免费版和收费版。

使用swagger，就是把相关的信息存储在它定义的描述文件里面（yml或json格式），再通过维护这个描述文件可以去更新接口文档，以及生成各端代码

想要了解、学习更多，请点击：https://www.bilibili.com/video/BV1YK4y1S7pw

使用swagger时如果碰见版本更新或迭代时，只需要更改swagger的描述文件即可。但是在频繁的更新项目版本时很多开发人员认为即使修改描述文件（yml或json）也是一定的工作负担，久而久之就直接修改代码，而不去修改描述文件了，这样基于描述文件生成接口文档也失去了意义。

想要了解、学习更多，请点击：https://www.bilibili.com/video/BV1YK4y1S7pw

Marty Pitt编写了一个基于Spring的组件swagger-springmvc。Spring-fox就是根据这个组件发展而来的全新项目。

Spring-fox是根据代码生成接口文档，所以正常的进行更新项目版本，修改代码即可，而不需要跟随修改描述文件。

想要了解、学习更多，请点击：https://www.bilibili.com/video/BV1YK4y1S7pw

Spring-fox利用自身AOP特性，把swagger集成进来，底层还是swagger。但是使用起来确方便很多。

所以在实际开发中，都是直接使用spring-fox。

编写SpringBoot项目，项目中controller中包含一个Handler，测试项目，保证程序可以正确运行。

想要了解、学习更多，请点击：https://www.bilibili.com/video/BV1YK4y1S7pw

在项目的pom.xml中导入Spring-fox依赖。目前最新版本为2.9.2，所以导入的依赖也是这个版本。其中springfox-swagger2是核心内容的封装。springfox-swagger-ui是对swagger-ui的封装。

想要了解、学习更多，请点击：https://www.bilibili.com/video/BV1YK4y1S7pw

版权声明：

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

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