SpringFox接口文档API DOC

悠悠 2022-10-11 00:50 171阅读 0赞

[https://springfox.github.io/springfox/docs/current/\#introduction][https_springfox.github.io_springfox_docs_current_introduction]

Springfox 的 Java 库套件都是关于为使用[spring 系列项目][spring]编写的 JSON API 自动生成机器和人类可读的规范。Springfox 的工作方式是在运行时检查应用程序一次，以根据 Spring 配置、类结构和各种编译时 Java 注释推断 API 语义。

### 1.1. 历史 ###

Springfox 是从最初由[Marty Pitt][]创建并命名为 *swagger-springmvc*的项目演变而来的。很多荣誉都归于马蒂。

### 1.2. 目标 ###

*  扩展对针对 JSON API 规范和文档的许多不断发展的标准的支持，例如：[swagger][]、[RAML][]和[jsonapi][]。
 *  扩展对[spring webmvc][]以外的[spring][spring webmvc]技术的支持
 *  从哲学上讲，我们希望不鼓励在运行时使用对服务描述不重要的（swagger-core）注释。例如，jackson 注释应该总是胜过或比`@ApiModelProperty`或例如`@NotNull`或指定@RequestParam\#required 应该总是胜出或有更多的权重 。在无法推断服务/模式特征的情况下，注释仅用于补充文档或覆盖/调整生成的规范。

### 1.3. Springfox Swagger  UI ###

该`springfox-swagger-ui` [网站罐子][Link 1]附带[扬鞭UI][UI]。要将其包含在标准 Spring Boot 应用程序中，您可以按如下方式添加依赖项：

<code>dependencies {
 compile 'io.springfox:springfox-swagger-ui:3.0.0'
 }</code>

拉入依赖项会创建一个包含 swagger-ui 静态内容的 webjar。它添加了一个 JSON 端点 `/swagger-resources`，其中列出了为给定应用程序配置的所有 swagger 资源和版本。Swagger UI 页面应该在[http://localhost:8080/swagger-ui.html][http_localhost_8080_swagger-ui.html]可用

![招摇的用户界面][ccd5628b2d4696b754277205ab059034.png]

[一个简单的springBoot 示例 ][springBoot _]

[https_springfox.github.io_springfox_docs_current_introduction]: https://springfox.github.io/springfox/docs/current/#introduction
[spring]: http://projects.spring.io/spring-framework
[Marty Pitt]: https://github.com/martypitt
[swagger]: http://swagger.io/
[RAML]: http://raml.org/
[jsonapi]: http://jsonapi.org/
[spring webmvc]: http://docs.spring.io/spring/docs/current/spring-framework-reference/html/mvc.html
[Link 1]: http://www.webjars.org/
[UI]: https://github.com/swagger-api/swagger-ui
[http_localhost_8080_swagger-ui.html]: http://localhost:8080/swagger-ui.html
[ccd5628b2d4696b754277205ab059034.png]: /images/20221005/11682f78ddf34434a753c412c8e2549a.png
[springBoot _]: https://blog.csdn.net/kongliand/article/details/107915029