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

皮特施

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

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

两种方法都可以使用,但是它们都使用左侧的编辑器打开,该编辑器显示YAML文件的内容,恕我直言,这浪费了大量的屏幕空间。并不是我真正想要的。是否可以选择在不打开编辑器的情况下显示OpenAPI文档?只需对未打开编辑器的https://petstore.swagger.io/做些什么即可。

或者...也许可以使用选项直接在GitHub上显示OpenAPI文档?

谢谢克里斯托夫

海伦

如果使用SwaggerHub,请在URL中用替换/apis//apis-docs/,仅查看API文档,而无需编辑器部分。例如:

https://app.swaggerhub.com/apis-docs/swagger-hub/registry-api/1.0.47


或者,如果您的OpenAPI定义托管在其他地方(例如GitHub上),则可以使用
https://petstore.swagger.io/?url=https://path/to/file.yaml

将其加载到公共Swagger UI演示中。Swagger UI无需编辑器即可呈现API文档。

本文收集自互联网,转载请注明来源。

如有侵权,请联系[email protected] 删除。

编辑于
0

我来说两句

0条评论
登录后参与评论

相关文章

来自分类Dev

如何在GitHub上使用markdown将原始HTML粘贴到README.md中?

来自分类Dev

如何在使用裸git存储库管理dotfile时在github上添加README.md但在主目录中没有相同的README.md?

来自分类Dev

如何在Github的配置文件中显示readme.md文件?

来自分类Dev

如何在 Github 的 README.md 文件中冻结列/行 Markdown 表?

来自分类Dev

如何在GitHub上的README.rst中强制更新图像(缓存)

来自分类Dev

如何在Github的README上添加R-CMD检查状态

来自分类Dev

如何向Github README.md添加背景图像

来自分类Dev

如何显示KaTex-GitHub README.md文件上的输出?

来自分类Dev

如何在Windows 7中打开'README.md'文件?

来自分类Dev

如何在 readme.md 中创建 HTML 代码块?

来自分类Dev

如何在 vscode 扩展的 README.md 中插入表格?

来自分类Dev

如何在Github上发布Delphi项目?

来自分类Dev

如何在Github上发布Delphi项目?

来自分类Dev

Python文档字符串到GitHub README.md

来自分类Dev

如何将彩色文本放入github的README.md或Index.md文件

来自分类Dev

如何将嵌入的动画gif添加到github存储库README.md?

来自分类Dev

将Bookmarklet嵌入GitHub README.md

来自分类Dev

将JavaScript嵌入GitHub README.md

来自分类Dev

Github readme.md对齐图像

来自分类Dev

github的README.md中注释的语法?

来自分类Dev

如何在readthedocs上发布我的github存储库?

来自分类Dev

如何在readthedocs上发布我的github存储库?

来自分类Dev

如何在 Github 上找到某个项目的发布

来自分类Dev

如何在GitHub上查看文档而不下载

来自分类Dev

如何将ohloh.net小部件添加到github项目readme.md文件中?

来自分类Dev

如何将ohloh.net小部件添加到我的github项目readme.md文件中?

来自分类Dev

如何在github中发布Java项目?

来自分类Dev

如何在github中发布Java项目?

来自分类Dev

Github在README.md中包含md文件?

Related 相关文章

  1. 1

    如何在GitHub上使用markdown将原始HTML粘贴到README.md中?

  2. 2

    如何在使用裸git存储库管理dotfile时在github上添加README.md但在主目录中没有相同的README.md?

  3. 3

    如何在Github的配置文件中显示readme.md文件?

  4. 4

    如何在 Github 的 README.md 文件中冻结列/行 Markdown 表?

  5. 5

    如何在GitHub上的README.rst中强制更新图像(缓存)

  6. 6

    如何在Github的README上添加R-CMD检查状态

  7. 7

    如何向Github README.md添加背景图像

  8. 8

    如何显示KaTex-GitHub README.md文件上的输出?

  9. 9

    如何在Windows 7中打开'README.md'文件?

  10. 10

    如何在 readme.md 中创建 HTML 代码块?

  11. 11

    如何在 vscode 扩展的 README.md 中插入表格?

  12. 12

    如何在Github上发布Delphi项目?

  13. 13

    如何在Github上发布Delphi项目?

  14. 14

    Python文档字符串到GitHub README.md

  15. 15

    如何将彩色文本放入github的README.md或Index.md文件

  16. 16

    如何将嵌入的动画gif添加到github存储库README.md?

  17. 17

    将Bookmarklet嵌入GitHub README.md

  18. 18

    将JavaScript嵌入GitHub README.md

  19. 19

    Github readme.md对齐图像

  20. 20

    github的README.md中注释的语法?

  21. 21

    如何在readthedocs上发布我的github存储库?

  22. 22

    如何在readthedocs上发布我的github存储库?

  23. 23

    如何在 Github 上找到某个项目的发布

  24. 24

    如何在GitHub上查看文档而不下载

  25. 25

    如何将ohloh.net小部件添加到github项目readme.md文件中?

  26. 26

    如何将ohloh.net小部件添加到我的github项目readme.md文件中?

  27. 27

    如何在github中发布Java项目?

  28. 28

    如何在github中发布Java项目?

  29. 29

    Github在README.md中包含md文件?

热门标签

归档