logo标签列表

将Swagger规范的JSON转换为HTML文档

yamlswaggerswagger-php
124

有些用PHP编写的REST API，我被要求创建Swagger文档。由于我不知道如何注释这些现有的API并创建这样的文档，因此我使用了这个编辑器来生成一些。

我保存了使用该编辑器创建的JSON和YAML文件，现在我需要从中创建“交互式”Swagger文档。

请问有人能告诉我如何将Swagger JSON规范文件转换为实际的Swagger文档吗？

我使用Windows平台，不了解Ant/Maven。

我尝试使用Swagger UI，但它无法渲染我的JSON。唯一显示的警告是：“此API正在使用已弃用的Swagger版本！请访问http://github.com/wordnik/swagger-core/wiki获取更多信息”。 - Salil
13个回答
2
如果您在Gitlab中提交您的JSON文件，它会为您呈现出来。
哇，那听起来不错。但愿他们可以在7年2个月前做到这一点 :-) - Salil
1

有一个小的Java程序，它可以从yaml文件生成文档（adoc或md）。

Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
        .withMarkupLanguage(MarkupLanguage.ASCIIDOC)
        .withSwaggerMarkupLanguage(MarkupLanguage.ASCIIDOC)
        .withOutputLanguage(Language.DE)
        .build();

Swagger2MarkupConverter builder = Swagger2MarkupConverter.from(yamlFileAsString).withConfig(config).build();
return builder.toFileWithoutExtension(outFile);

很遗憾，它仅支持OpenAPI 2.0而不支持OpenAPI 3.0。

1

我对 Rapidoc 感到非常满意：https://rapidocweb.com/

我为什么喜欢它：

  • 易于使用
  • 'Try' 选项
  • 可以添加代码示例
  • 可与其他 HTML 页面集成
  • 可以添加 CSS 并更改布局
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接