有什么方法可以与其他人共享AsyncAPI文档吗?我用过AsyncAPI Studio编写我的 API 文档。但我在 AsyncAPI studio 中找不到共享选项。 AsyncAPI Studio/任何其他 AsyncAPI 编辑器中是否有一种方法可以用来与其他人共享我们的 API 文档?
在 SwaggerHub我们可以与其他人分享使用 OpenAPI 规范编写的 REST API 文档。
最佳答案
是的,你有这种可能性,但有限。 Studio 不会将您的规范保存在云中(没有服务器),但如果您的规范通过 http 共享到某处,那么您可以将 url
参数与 readOnly
一起使用code> 参数 - 后者决定工作室是否应该使用或不使用编辑器来渲染规范。
也可以使用 base64
参数,但由于链接长度有限,仅适用于小规范。
示例:
- 带有
url
参数:https://studio.asyncapi.com/?url=https://raw.githubusercontent.com/asyncapi/spec/master/examples/gitter-streaming.yml&readOnly - 使用
base64
参数:https://studio.asyncapi.com/?base64=YXN5bmNhcGk6ICcyLjQuMCcKaW5mbzoKICB0aXRsZTogQWNjb3VudCBTZXJ2aWNlCiAgdmVyc2lvbjogMS4wLjAKICBkZXNjcmlwdGlvbjogVGhpcyBzZXJ2aWNlIGlzIGluIGNoYXJnZSBvZiBwcm9jZXNzaW5nIHVzZXIgc2lnbnVwcwpjaGFubmVsczoKICB1c2VyL3NpZ25lZHVwOgogICAgc3Vic2NyaWJlOgogICAgICBtZXNzYWdlOgogICAgICAgICRyZWY6ICcjL2NvbXBvbmVudHMvbWVzc2FnZXMvVXNlclNpZ25lZFVwJwpjb21wb25lbnRzOgogIG1lc3NhZ2VzOgogICAgVXNlclNpZ25lZFVwOgogICAgICBwYXlsb2FkOgogICAgICAgIHR5cGU6IG9iamVjdAogICAgICAgIHByb3BlcnRpZXM6CiAgICAgICAgICBkaXNwbGF5TmFtZToKICAgICAgICAgICAgdHlwZTogc3RyaW5nCiAgICAgICAgICAgIGRlc2NyaXB0aW9uOiBOYW1lIG9mIHRoZSB1c2VyCiAgICAgICAgICBlbWFpbDoKICAgICAgICAgICAgdHlwZTogc3RyaW5nCiAgICAgICAgICAgIGZvcm1hdDogZW1haWwKICAgICAgICAgICAgZGVzY3JpcHRpb246IEVtYWlsIG9mIHRoZSB1c2Vy&readOnly
关于api - 如何与他人共享 `AsyncAPI`文档?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/73397420/