Apicurio-studio: OpenShiftのApicurioのRedoclyで「Tryit」コンソールを有効にする方法。

作成日 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スタジオで「試してみる」機能を有効にする方法があるかどうかを知っておくと便利です。

私の理解では、ReDocのTryIt機能はオープンソース製品には含まれていません。 したがって、Studioでそれを有効にする方法はないと思います。 私が間違っていれば、私はそれを知ってとても幸せになります。 :)

@EricWittmann
RapiDocとSwaggerUIには試用機能がありますが、Redocにはありません。 ドキュメントのUIを切り替えることができればいいのですが、そうする予定はありますか?

RapiDoc
https://mrin9.github.io/RapiDoc/index.html
Swagger UI
https://swagger.io/tools/swagger-ui/

興味深いことに、プレビュー機能ではすでにrapidocの実験的なサポートがあります。 プレビューURLに&rid=rapidocを追加すると、それを確認できます。 例えば:

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/preview_rapidoc.template#L8

これを有効にするには、 allow-try=trueか、属性をtrueとして削除します。これがデフォルトです。

ああ、そうです。申し訳ありませんが、その機能を明確に無効にしたことを忘れました。 思考プロセスを思い出せませんが、おそらく私のAPI記述のどれもそれらを裏付ける実際のサービスを持っていませんでした。

これらの機能を有効/無効にしやすくするために、ここで簡単に実行できる作業がいくつかあると思います。 貢献に興味のある方はぜひご案内します! ユーザーがレンダラーを選択できるようにする方法、デフォルトのレンダラーを設定する方法、レンダラーをグローバルに構成する方法、またはおそらくデザインごとに構成する方法を検討する必要があります。

私は貢献することに興味があるかもしれません、私は連絡します!

このページは役に立ちましたか?
0 / 5 - 0 評価