開発環境のセットアップ

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

前提条件

git、任意のバージョン
このリポジトリは、最低限 **Node.js >=22.11.0** と **npm >=10.9.0** で動作しますが、常に最新バージョンの Node.js を使用することをお勧めします。

手順

git clone https://github.com/swagger-api/swagger-ui.git
cd swagger-ui
npm install
npx husky init (オプション)
npm run dev
しばらくお待ちください
https://:3200/ を開きます

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

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

置換

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

と

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

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

ボーナスポイント

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