maira-cli
MairaCLIは、APIエンドポイントをテストする際にリクエストとレスポンスをインターセプトすることによって、エンドポイントのSwaggerドキュメントを自動的に生成するために設計された開発者ツールです.
カテゴリーにリストされています:
開発ツールカテゴリオープンソース
説明
MairaCLIは、テスト中にリクエストとレスポンスをインターセプトすることによって、APIエンドポイントのSwaggerドキュメントを自動的に生成するために設計された開発者ツールです。
使い方 maira-cli?
MairaCLIを使用するには、npmを介してインストールし、バックエンドプロジェクト内でプロキシサーバーを起動し、config.jsonファイルに必要な詳細を設定し、プロキシサーバーを通じてバックエンドにリクエストを送信します。リクエストを送信した後、提供されたコマンドを使用してドキュメントを生成します。
の主な機能 maira-cli:
1️⃣
APIエンドポイントのSwaggerドキュメントを自動的に生成
2️⃣
正確なドキュメントのためにリクエストとレスポンスをインターセプト
3️⃣
プロジェクトルートのための設定ファイルを作成
4️⃣
ドキュメントプレビューリンクを生成
5️⃣
カスタム認証ヘッダーをサポート
なぜ使用するのか maira-cli?
| # | ユースケース | ステータス | |
|---|---|---|---|
| # 1 | バックエンドプロジェクトのAPIドキュメントを生成 | ✅ | |
| # 2 | ドキュメント化しながらAPIエンドポイントをテスト | ✅ | |
| # 3 | マイクロサービスのためのSwaggerドキュメントを作成 | ✅ | |
開発者 maira-cli?
MairaCLIは、開発者のためのAPIドキュメント作成プロセスを簡素化することを目的としたGitHubの貢献者コミュニティによって開発されました。