小编pit*_*chr的帖子

如何在 GitHub (readme.md) 上发布 OpenAPI 文档的最佳方式?

我在 GitHub 上托管了一个项目。为了记录 API,我使用 OpenAPI 规范。现在,我想在readme.md(GitHub 上)添加一个链接,将我的访问者引向 OpenAPI 文档,以获得良好的用户体验。

据我所知,我有两个解决方案:

两种方法都有效,但它们都在左侧打开一个编辑器,显示 YAML 文件的内容,恕我直言,浪费了大量的屏幕空间。实在不是我想要的。是否有一个选项可以在不打开编辑器的情况下显示 OpenAPI 文档?与https://petstore.swagger.io/的操作类似,无需打开编辑器。

或者...是否有一个选项可以直接在 GitHub 上显示 OpenAPI 文档?

谢谢,克里斯托夫

github swagger-editor openapi

5
推荐指数
1
解决办法
9622
查看次数

标签 统计

github ×1

openapi ×1

swagger-editor ×1