接口文档工具 如何优雅的生成接口文档

在应用开发过程中，往往需要向其他应用或客户端提供RESTful API接口，尤其是在版本快速迭代的开发过程中，在修改接口时，还需要同步修改对应的接口文档，这让我们总是做重复的工作，如果忘记修改接口文档，可能会造成不必要的麻烦。

为了解决这些问题，斯瓦格诞生了。先简单了解一下。

斯瓦格介绍

Swagger是一个标准和完整的框架，用于生成、描述、调用和可视化RESTful风格的网络服务。

总体目标是让客户端和文件系统充当服务器，并以相同的速度更新。文件的方法、参数和模型被紧密地集成到服务器端的代码中，允许应用编程接口一直保持同步。

接下来，我们将Swagger集成到Spring Boot中，构建一个强大的接口文档。

春靴集成了霸气

将Swagger与Spring Boot集成有三个主要步骤:

添加斯瓦格依赖

添加斯瓦格文档配置

使用斯瓦格注释编写应用编程接口文档

加入依赖项

首先，创建一个项目，并将斯瓦格依赖项添加到该项目中。项目依赖关系如下:

具体来说，您可以直接运行github项目并检查它。

回到顶端

4.增强的工具-霸气-引导-用户界面

swaggy-bootstrap-ui是springfox-swaggy的增强UI实现，它为Java开发人员在使用swaggy时提供了简单而强大的界面文档体验

项目地址:https://github.com/xiaoymin/swagger-bootstrap-ui

作者对这个项目的描述已经非常清楚了。

，用法

在使用上，就像之前常见的版本工具一样，只需要将jar包spring fox-swag-ui替换为swag-bootstrap-ui即可。

，访问路径

Http://$:$/项目访问地址名称/doc.html

截图显示

生成接口文档md

回到顶端

5.摘要

可以直接使用增强版的swag-bootstrap-ui！

14赞踩3评

分享

报告

路飞写代码南大通用数据技术有限公司，数据库架构师，优质技术领域创造者05-13 16:34关注

后端接口文档

首先从后端来说，目前广泛使用的是Swagger，可以说是大多数后端开发人员首选的接口文档制作工具。产生的界面描述详细清晰，甚至可以通过界面文档服务进行验证！

然后它的配置相对简单易用，这也是它受到很多后端开发者喜爱的原因。当然，swaggy不仅支持java，还支持多种语言，目前主流的语音都非常支持swaggy！

前端接口文档

就前端而言，因为作者是一个工作了7年的前端工程师，对于前端的接口文档，我更喜欢一个叫docsify的工具。这个文档是直接MarkDown语法生成文档，目前所有知名前端框架采用的文档大部分也是docsify工具生成的！

那么这个工具的好处就是你写的markdown语法在任何markdown语法浏览工具上都可以识别，而且MarkDown语法相对简单，减少了学习语法的额外负担。是一个非常好的工具，笔者也强烈建议前端从业者可以尝试一下这个工具。