バージョン: Latest(v3.0) 🔥

API Search · Design · Test · Share

경로: APIM Console > 左側サイドメニュー > API管理 > API名をクリック > API詳細 > API配布
Swagger 미등록 시 선행 작업
1. 上記のSwagger管理ステップでSwaggerインポートパスを設定します
2. API詳細画面に戻り、Swagger 가져오기の後にSwagger 저장하기をクリックして保存します
배포: API詳細画面で配布を進めます。

경로: APIM Console > 左側サイドメニュー > API Search
시나리오: 開発するAPIエンドポイントの存在を確認し、修正/新規開発を決定します
- パス、メソッド、リクエスト/レスポンスボディフィールド、サマリー、説明などを検索します
- すでに必要なエンドポイントがある場合: 別途開発せずに既存のAPIを活用します
- 一部フィールド追加など軽微な変更が必要な場合: 既存エンドポイントの実行テスト後、履歴を保存・共有して変更必要事項を開発者に伝えます
- 全くない場合: 新規APIエンドポイントを設計/開発します
주의사항
- ⚠️ API SearchのためにAPIM에 Swagger를 등록 관리する必要があります。
- ⚠️ API SearchはSwagger 정보を基に結果が照会されます。

경로: APIM Console > 左側サイドメニュー > API Docs Validation
시나리오: 新規開発または既存API変更時に「API形式検証」で文書標準遵守を検証します
1. ローカル/開発環境でプログラムが生成したSwagger JSONを抽出します
2. APIMの「API形式検証」にアップロード/入力して検証を実行します
3. 結果を確認し、標準未遵守が発生した場合、プログラムを修正し、最終的に検証を通過させます
주의사항
- ⚠️ 検証環境で検証を通過させた後、運用環境への配布を進めるようにします。
- ⚠️ これにより運用環境では標準化された文書形式で登録/配布/管理されることが可能になります。