swagger - 是否可以从 ReadeMe.md 文件中的 swagger YAML 文件渲染 Swagger UI？只显示一次 UI 在 github 提交代码

Question

有什么方法可以在 ReadeMe.md 中可视化 swagger YAML 文件。我可以放文件的唯一方法 [Swagger Codegen](/assets/swagger.yaml)

我的代码库结构是

Project
  src
  assets
     swagger.yaml
  ReadeMe.md

Answer 1

你可以试试把 swagger.yaml 转成 markdown，然后放到 readme 里。

转换工具如:https://github.com/syroegkin/swagger-markdown

这里有一个在线演示:https://swagger-markdown-ui.netlify.app/