2016-05-30 12 views
0

localhostを使用するSwagger UIで検索を実装する質問があります。Swagger UIで検索を実装する

私はオンラインで検索しており、これに対する回答は見つかりませんでした。

私の質問は次のとおりです。「Swagger UIで検索を実装することができるので、人々はAPIのパスを検索できますか?」

ありがとうございます!

+1

検索を実装することは、正確にはどういう意味ですか?上部の検索ボックスのように?ブラウザの検索では十分ではありませんか? – Sampada

答えて

3

GoogleグループのOfficial Swaggerコミュニティページで回答を受け取りました。

彼らはgithubの次のページを提案しました。これは私が探していたものでした。これはSwaggerのUIで非常に見栄えのある検索の実装です。とにかく

https://github.com/swagger-api/swagger-ui/pull/2116

私の質問に答えるためのおかげで!

0

このswagger-uiにはこれまでのui検索オプションはありません。しかし、解決策として2つの選択肢があります。

  1. デフォルトでは、swagger-uiは、パス(APIコードの@Api()で注釈付けされた)に基づいてapisのセットをリストします。以下の例では、2つのパス(価格チェックとpdp詳細)に基づいてapiを一覧表示しています。 enter image description here

2.Youは、明示的にのみ、特定のパスの下にリストされているAPIを表示するには威張っ-UIを伝えることができます。以下の例では、価格チェックのみの下に一覧表示されています。

enter image description here これを行うには、そのpath-docをswaggerで設定する必要があります。

スワッガーアノテーションの詳細については、thisを参照してください。

UPDATE:

IN-が威張っ-UI searchが利用可能になりました建て。

+1

こんにちは、答えに感謝します。本当に私が探していたものではありません。とにかくありがとう! – Ward

+0

NP。私もあなたの答えから新しいものを見つけました。 –