将 openapi 3 文档（json 或 yaml）转换为 markdown、adoc 或任何其他静态格式的首选方法

发布于 2025-01-18 09:08:41 字数 259 浏览 0 评论 0原文

我尝试在 java 中找到一种简单的方法来将 openapi 3 文档（json 或 yaml）转换为静态格式，如 markdown、html 或 adoc。搜索周围我发现了一个像 Swagger2Markup 这样的视图项目，但它们还没有为 Openapi v3 做好准备！

有人对我的库或 Maven 插件有任何建议或提示吗？

原文

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

诠释孤独 2025-01-25 09:08:41

您可能需要检查项目 https://github.com/mermade/mermade/widdershins
这是一个不错的工具，可将OpenAPI规格转换为Markdown。
它是一个NPM模块，它正在生成用于REDOC上的降压，但是您仍然可以自定义生成的模板

回复收藏 0 原文

抚你发端 2025-01-25 09:08:41

我找到了正确的Maven插件：

<plugin>
    <!-- converts the openapi docu to html -->
    <groupId>io.swagger.codegen.v3</groupId>
    <artifactId>swagger-codegen-maven-plugin</artifactId>
    <version>3.0.35</version>
    <executions>
        <execution>
            <id>export-opennapi-to-html-doc</id>
            <goals>
                <goal>generate</goal>
            </goals>
            <configuration>
               <inputSpec>${project.build.directory}/api.yml</inputSpec>
               <language>html2</language>
               <output>${project.basedir}/docs</output>
             </configuration>
         </execution>
    </executions>
</plugin>

I've found the correct maven plugin to do this:

<plugin>
    <!-- converts the openapi docu to html -->
    <groupId>io.swagger.codegen.v3</groupId>
    <artifactId>swagger-codegen-maven-plugin</artifactId>
    <version>3.0.35</version>
    <executions>
        <execution>
            <id>export-opennapi-to-html-doc</id>
            <goals>
                <goal>generate</goal>
            </goals>
            <configuration>
               <inputSpec>${project.build.directory}/api.yml</inputSpec>
               <language>html2</language>
               <output>${project.basedir}/docs</output>
             </configuration>
         </execution>
    </executions>
</plugin>

回复收藏 0 原文

~没有更多了~