🔍
OpenAPI 仕様書に検索機能を追加する (openapi-generate-html)
OpenAPI の仕様書をお手軽に HTML に変換する openapi-generate-html に、検索機能を追加しました。
これにより、エンドポイントの検索が簡単におこなえるようになります。
使い方
以下のコマンドで簡単に HTML を生成できます。
npx openapi-generate-html -i {任意の OpenAPI の JSON または YAML パス}
生成された HTML ファイルを開くと、画面右上に検索ボタンが表示されます。
検索ボタンをクリックすると、検索モーダルが表示されてエンドポイントをキーワードで絞り込むことができます。
ショートカットキーも使えます。 Mac は ⌘+k、Windows は Ctrl+k。
サジェストされたエンドポイントを選ぶと、該当の API を一発で表示できます🙌
エンドポイント数が多いAPIほど、便利に感じていただけるはずですので、ぜひお試しください！
その他
テーマ変更など、その他のオプションは下記をご覧ください。
Discussion