Swagger Editorドキュメント

このページは現在のSwagger Editorに関するものです。Swagger Editor Next（ベータ版）のドキュメントをお探しの場合は、Swagger Editor Next（ベータ版）をご覧ください。

Swagger Editorは、Swagger仕様でRESTful APIを設計、定義、文書化するためのオープンソースエディターです。Swagger EditorのソースコードはGitHubにあります。

GitHub：https://github.com/swagger-api/swagger-editor

ダウンロード

Web上でのエディターの使用

エディターはあらゆるWebブラウザで動作し、ローカルでホストすることも、Webからアクセスすることもできます。

Webバージョンに移動

ローカルマシンでのエディターの使用

Swagger Editorをマシン上で実行して使用することもできます。

前提条件

Swagger Editorをダウンロードして実行する前に、以下の依存関係をマシンにインストールする必要があります。

• NodeJS

NodeJSが正常にインストールされたら、次を使用してすべてのnpm依存関係をインストールしてください

npm install;

GitHubのhttp-serverモジュールを使用したセットアップ

Swagger Editorは、GitHubのこのパブリックリポジトリにあります。

GitHubのhttp-serverモジュールを使用してエディターを実行するには、以下を実行してください。Githubから最新バージョンをダウンロードした後、ターミナルでこれらのスクリプトを実行する必要があります。

npm install -g http-server
wget https://github.com/swagger-api/swagger-editor/releases/download/v2.10.4/swagger-editor.zip
unzip swagger-editor.zip
http-server swagger-editor

Dockerからのセットアップ

Swagger Editorは、Dockerのこのパブリックリポジトリにあります。

Dockerからローカルマシンでエディターを実行するには、以下を実行してください。

docker pull swaggerapi/swagger-editor
docker run -p 80:8080 swaggerapi/swagger-editor

貢献

Swagger Editorは、Apacheライセンスに基づくオープンソースプロジェクトです。Swagger Editor GitHubリポジトリで、提案、アイデア、バグレポート、プルリクエストを提出してプロジェクトに貢献できます。

エディターのソースコードを表示し、ローカルマシンからプロジェクトに取り組むには、以下を実行してください。

git clone https://github.com/swagger-api/swagger-editor.git
cd swagger-editor
npm install
npm run build
npm start

一般的な問題

• npm startが機能しない場合は、**node_modules**フォルダーを削除してから、npm installとnpm startを実行してください
• クローン作成後に**dist**フォルダーに問題がある場合は、ルートに移動してnpm run buildを実行してください