開発環境のセットアップ

Swagger UIには、ホットモジュールリロードと非縮小スタックトレースを提供する開発サーバーが含まれており、開発が容易になります。

前提条件

  • git（任意のバージョン）
  • このリポジトリを実行するために必要な最小バージョンはNode.js >=20.3.0とnpm >=9.6.7ですが、常に最新バージョンのNode.jsを使用することをお勧めします。

手順

  1. git clone https://github.com/swagger-api/swagger-ui.git
  2. cd swagger-ui
  3. npm run dev
  4. しばらくお待ちください
  5. http://localhost:3200/を開きます

ローカル開発ビルドで独自のローカルAPI定義を使用する

dev-helpers/dev-helper-initializer.jsで`url`パラメーターを変更することで、ローカルファイルを指定できます。このローカルファイルは、`dev-helpers`ディレクトリまたはそのサブディレクトリに存在する必要があります。便宜上、そしてベストプラクティスとして、既に`.gitignore`に指定されている`dev-helpers/examples`サブディレクトリを作成することをお勧めします。

置き換え

url: "https://petstore.swagger.io/v2/swagger.json",

で

url: "./examples/your-local-api-definition.yaml",

`dev-helpers`内のファイルは、gitにコミットしないでください。例外は、`index.html`、`oauth2-redirect.html`、`dev-helper-initializer.js`を修正する場合、または新しいサポートファイルを追加する場合です。

ボーナスポイント

  • Swagger UIにはESLintルール定義が含まれています。グラフィカルエディターを使用する場合は、ESLintプラグインをインストールすることを検討してください。これにより、コーディング中に構文とスタイルのエラーが指摘されます。
    • リンターはPRテストシーケンスの一部として実行されるため、無視することはできません！