什么是swagger、springfox

Swagger是一系列用于Restful API开发的工具，开源的部分包括：

OpenAPI Specification：API规范，规定了如何描述一个系统的API
Swagger Codegen：用于通过API规范生成服务端和客户端代码
Swagger Editor：用来编写API规范
Swagger UI：用于展示API规范

非开源的部分包括：

Swagger Hub：云服务，相当于Editor + Codegen + UI
Swagger Inspector：手动测试API的工具
SoapUI Pro：功能测试和安全测试的自动化工具
LoadUI Pro：压力测试和性能测试的自动化工具

springfox以这样的方式出现

<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.2.2</version>
</dependency>
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.2.2</version>
</dependency>

第二个看起来应该是springfox封装/修改的Swagger UI，第一个应该就是Springfox本体了，但为什么artifact有个swagger2的后缀？

Springfox其实是一个通过扫描代码提取代码中的信息，生成API文档的工具。API文档的格式不止Swagger的OpenAPI Specification，还有RAML，jsonapi，Springfox的目标同样包括支持这些格式。这就能解释那个swagger2的后缀了，这只是Springfox对Swagger的支持。

在Swagger的教程中，都会提到@Api、@ApiModel、@ApiOperation这些注解，这些注解其实不是Springfox的，而是Swagger的。springfox-swagger2这个包依赖了swagger-core这个包，而这些注解正是在这里面。但是，swagger-core这个包是只支持JAX-RS2的，并不支持常用的Spring MVC。这就是springfox-swagger的作用了，它将上面那些用于JAX-RS2的注解适配到了Spring MVC上。

除了Spring MVC外，Springfox还支持如下库

Spring Data REST
JSR 303，这项标准的参考实现是Hibernate Validator

什么是swagger、springfox相关推荐

springboot学习(七十三) springboot中使用springdoc替换swagger(springfox)
文章目录前言一.springdoc介绍二.使用步骤 1.引入库 2. 创建一个spring配置类,添加springdoc的配置 3. 常用的swagger注解和springdoc的对应关系 4. ...
Dubbo 版 Swagger 来啦！Dubbo-Api-Docs 发布
作者 | 柯然(邪影) 来源|阿里巴巴云原生公众号背景 Swagger 是一个规范和完整的前端框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.Swagger 规范也逐渐发展 ...
Dubbo 版 Swagger 来啦！
简介:Swagger 是一个规范和完整的前端框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.Swagger 规范也逐渐发展成为了 OpenAPI 规范. 作者 | 柯然(邪影 ...
Spring Boot集成Swagger
Spring Boot集成Swagger @(Swagger)[swagger, springfox, springboot] Spring Boot集成Swagger 前言基本概述案例引入依赖 ...
Swagger使用方法笔记
1. Swagger简介前后端分离前端 -> 前端控制层.视图层后端 -> 后端控制层.服务层.数据访问层前后端通过API进行交互前后端相对独立且松耦合产生的问题前后端集成, ...
Swagger 实战教程-姚海陆-专题视频课程
Swagger 实战教程-95人已学习课程介绍 Swagger 教程录制计划.自学整理方式. Swagger .Swagger UI. Springfox简介,三者之间的联系. Sp ...
SpringBoot14：集成Swagger终极版
学习目标: 了解Swagger的概念及作用掌握在项目中集成Swagger自动生成API文档 Swagger简介前后端分离前端 -> 前端控制层.视图层后端 -> 后端控制层.服务层 ...
Swagget技术·SpringBoot继承Swagger框架详解！
文章目录一.Swagger简介二.SpringBoot集成Swagger 三.配置Swagger 1.Swagger实例Bean是Docket,所以通过配置Docket实例来配置Swaggger. ...
Swagger接口在线文档
1.Swagger是什么? Swagger围绕OAS构建RESTFUL文档: Swagger动态生成接口定义文档: Swagger易用免费且开源: Swagger就是将项目中所有的接口展现在页面上,并 ...
超详细Swagger基本使用方法【狂神】
文章目录 Swagger 1. Swagger简介 2. 第一个Swagger程序 3. Swagger的配置 3.1 配置基本页面 3.2 配置扫描接口 3.3 配置Swagger开关 3.4 配置 ...

什么是swagger、springfox

什么是swagger、springfox相关推荐

最新文章

热门文章