Apicurio-studio: 如何在 OpenShift 上的 Apicurio 中的 Redocly 中启用“试用”控制台。

创建于 2021-05-26  ·  7评论  ·  资料来源: Apicurio/apicurio-studio

大家好,很抱歉提出一个问题,但我搜索了这个项目和谷歌,但找不到如何做到这一点。 此链接中的 Redocly 文档描述了如何在 Redocly yaml 文件中执行此操作https://redoc.ly/docs/api-reference-docs/console-overview/#enable -the-try-it-api-console 但我我不确定如何在 Docker/k8s 安装中执行此操作。 我没有看到任何适用的环境变量。 在此先感谢您的帮助。

question

最有用的评论

我可能有兴趣贡献,我会联系!

所有7条评论

好问题。 很高兴知道是否有办法在 APICurio Studio 中启用“试用”功能。

我的理解是 ReDoc 的 Try It 功能不包含在开源产品中。 所以我认为没有办法在 Studio 中启用它。 如果我错了,我会很高兴知道。 :)

@埃里克·维特曼
RapiDoc 和 SwaggerUI 有试用功能,但 Redoc 没有。 能够在文档 UI 之间切换会很好,是否有这样做的计划?

快速文档
https://mrin9.github.io/RapiDoc/index.html
招摇的用户界面
https://swagger.io/tools/swagger-ui/

有趣的是,我们已经在预览功能中提供了对 Rapidoc 的实验性支持。 如果您将&rid=rapidoc到预览 URL,您可以看到它。 例如:

image

相关代码在这里:

https://github.com/Apicurio/apicurio-studio/blob/master/front-end/servlet/src/main/java/io/apicurio/studio/fe/servlet/servlets/PreviewServlet.java#L78 -L82

对 Swagger UI 等其他渲染器的贡献并不难!

很酷,我喜欢 Rapidoc 的外观和感觉,尽管 Apicurio 中禁用了试用功能:
https://github.com/Apicurio/apicurio-studio/blob/dfc277b03032562e4a3d37f16c851159340495b0/front-end/servlet/src/main/resources/io/apicurio/studio/fe/servlet/servlets.template#Lrapi8

要启用它,请设置allow-try=true或删除该属性为 true 是默认值。

啊,是的 - 抱歉,我忘了我特意禁用了该功能。 我不记得思考过程,但可能我的 API 描述都没有真正的服务支持它们。

我认为这里可以轻松完成一些工作,使这些功能更容易启用/禁用。 我很乐意指导任何有兴趣做出贡献的人! 我们需要考虑如何允许用户在渲染器之间进行选择、设置默认渲染器、全局或每个设计配置渲染器。

我可能有兴趣贡献,我会联系!

此页面是否有帮助?
0 / 5 - 0 等级