我有一个托管在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] 删除。
我来说两句