Swagger Editor のドキュメント

このページは現在の Swagger Editor に関するものです。Swagger Editor Next (ベータ版) (別名 SwaggerEditor@5) のドキュメントをお探しの方は、Swagger Editor Next (ベータ版) をご覧ください。

Swagger Editor は、OpenAPI Specification で HTTP (RESTful) API を設計、定義、ドキュメント化するためのオープンソースエディタです。Swagger Editor のソースコードは GitHub で見つけることができます。

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

Swagger Editor Next のみが OpenAPI 3.1.0 をサポートしています。SwaggerEditor@4 は OpenAPI 3.1.0 のサポートを受けることはなく、現時点ではレガシーと見なされています。計画では、将来的に SwaggerEditor@5 に完全に移行し、SwaggerEditor@4 を非推奨とすることです。

Webでのエディタの使用

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

ウェブ版へ

ローカルでの実行

前提条件

git、どのバージョンでも
このリポジトリが動作するための最低限必要なバージョンは Node.js >=20.3.0 と npm >=9.6.7 ですが、常に最新バージョンの Node.js を使用することをお勧めします。

1
 $ npm i --legacy-peer-deps

Node.js と npm がインストールされている場合は、npm start を実行して静的サーバーを起動できます。

それ以外の場合は、ブラウザでファイルシステムから直接 index.html を開くことができます。

Swagger Editor にコード変更を加えたい場合は、npm run dev を介して Webpack ホットリロード開発サーバーを起動できます。

ブラウザのサポート

Swagger Editor は、Chrome、Safari、Firefox、および Edge の最新バージョンで動作します。

既知の問題

移行を支援するために、現在判明している 3.X の問題点を以下に示します。このリストは定期的に更新され、以前のバージョンで実装されていなかった機能は含まれません。

Swagger UI の既知の問題に記載されているすべて。
codegen との統合はまだありません。

便利なスクリプト

以下のスクリプトは、プロジェクトのルートディレクトリで npm run


  ©  . This site is unofficial and not affiliated with Swagger.