API ReDoc 和 Spring 引导文档

Question

有人可以分享一些有关如何使用 ReDoc 和 SpringBoot 框架实现 API 文档的示例。如果有人知道 ReDoc + Springboot 的一些很好的例子，那将是很大的帮助。

Answer 1

您可以创建一个 spring 启动应用程序启用 springdoc-openapi-ui [1]，然后添加一个静态 html [2]，如下所示here！通过将 spec-url 更改为 http://localhost:8080/v3/api-docs [3]

[1] : https://www.baeldung.com/spring-rest-openapi-documentation

[2] :

[3] :

<!DOCTYPE html>
<html>
  <head>
    <title>Redoc</title>
    <!-- needed for adaptive design -->
    <meta charset="utf-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">

    <!--
    Redoc doesn't change outer page styles
    -->
    <style>
      body {
        margin: 0;
        padding: 0;
      }
    </style>
  </head>
  <body>
    <redoc spec-url='http://localhost:8080/v3/api-docs'></redoc>
    <script src="https://cdn.jsdelivr.net/npm/redoc@latest/bundles/redoc.standalone.js"> </script>
  </body>
</html>

API ReDoc 和 Spring 引导文档

API Documentation with ReDoc and Spring boot

spring

spring-mvc

spring-boot

redoc