返回

SwaggerUI 再见！这款开源API文档生成神器，界面更炫酷，逼格更高

后端

在使用 Spring Boot 开发前后端分离项目时，Swagger 是不可或缺的工具。它是一个规范和完整的框架，用于生成、、调试和可视化 RESTful 风格的 Web API 服务。然而，默认的 SwaggerUI 界面往往显得有些单调乏味。别担心，现在有一款开源的API文档生成神器横空出世，它拥有更炫酷的界面和更高的逼格，让您的API文档脱颖而出！

这款神器名为 Redocly，它是一款开源的API文档生成工具，可以帮助您轻松生成美观、交互式的API文档。Redocly 的界面设计简洁、现代，让您的API文档看起来更加专业和引人注目。

使用 Redocly 生成API文档非常简单，只需在您的项目中添加一个依赖即可：

<dependency>
    <groupId>org.redocly</groupId>
    <artifactId>redocly-spring-boot-starter</artifactId>
    <version>latest-version</version>
</dependency>

添加依赖后，您需要在项目中配置 Redocly。您可以通过在 application.yml 或 application.properties 文件中添加以下配置来完成：

redocly:
  enabled: true
  title: "My API Documentation"
  description: "This is the documentation for my API."
  version: "1.0.0"
  basePath: "/"

配置好 Redocly 后，您就可以通过访问 /redocly/index.html 来查看生成的API文档了。您还可以通过在 application.yml 或 application.properties 文件中添加以下配置来修改文档的访问路径：

redocly:
  path: "/my-api-docs"

Redocly 还提供了丰富的功能，可以帮助您轻松生成高质量的API文档。这些功能包括：

  • 自动生成API文档：Redocly 可以从您的代码中自动生成API文档，您无需手动编写任何文档。
  • 支持多种语言：Redocly 支持多种语言，包括英语、中文、法语、德语、西班牙语等。
  • 支持多种格式：Redocly 可以将API文档导出为多种格式，包括HTML、JSON、Markdown 等。
  • 支持自定义主题：Redocly 提供了多种预定义的主题，您也可以自定义自己的主题。

如果你厌倦了丑陋的 SwaggerUI，不妨试试 Redocly 吧！这款开源的API文档生成神器拥有更炫酷的界面和更高的逼格，让您的API文档脱颖而出！