最終更新：
Click to expand / collapse
APIが開発者に優しいものであるためには、明確で、テスト用にアクセス可能であり、十分に文書化されている必要があります。Swagger UI、 Postman、 Insomniaを接続して構成します。APIをすばやくテストし、要求の構造を理解し、内部チームと外部パートナーの両方の統合プロセスを容易にすることができる3つの最も人気のあるツールです。
これらのツールが必要な理由
| ［ツール］ | アポイントメント |
|---|---|
| スワガーUI | OpenAPI仕様オンラインドキュメントの自動生成 |
| ポストマン（Postman） | クエリ、コレクション、スクリプトの手動および自動テスト |
| 不眠症（Insomnia） | 簡単なデバッグ、変数、トークン、GraphQL、 REST、 gRPCの操作 |
私たちが追求している機会
コードからOpenAPI （Swagger）仕様を生成する
スワガーUI
すべてのエンドポイントの例でPostman/Insomniaにコレクションをインポートする
ツールでのOAuth2、 JWT、 APIキーの操作
テストとドキュメントをCI/CDパイプラインと同期させる
外部パートナーへのコレクションの公開
チームと顧客のための利点
新規開発者の迅速な初期登録
外部チームによる迅速な統合
API構造上の単一の真実のソース
あらゆる段階でテストとデバッグを簡素化
パートナーからの質問や統合エラーを軽減
特に重要な点
APIまたはSDKプラットフォームを開く
頻繁な変更を伴う内部マイクロサービス
APIファースト製品とB2Bサービス
チームの開発と変更が高速なプロジェクト
Swagger UI、 Postman、 Insomniaは、最新のAPI開発に必須のツールです。お客様のAPIがチーム内およびパートナーの両方で透明でテスト可能で使いやすいように接続および構成します。