API設計規範 - Apidog Docs

Apidog バージョン「2.7.22」以降が必要です。

Apidogでは、すべてのAPIドキュメントをOpenAPI（Swagger）仕様に準拠して設計することを強く推奨しています。APIにおいてこの仕様に従う重要性については、こちらの記事をご参照ください。

Apidogの多くの機能、たとえばAIによるAPI適合性チェックやAI命名などは、十分に定義されたAPI設計規範に基づいて動作します。標準化された規範を導入することで、以下のような利点があります。

Apidogの各種機能を最大限に活用できる

チーム全体で設計方針を統一できる

Apidogでは、フォルダツリー上部の「+」＞「新しいAPI設計規範」をクリックすることで、新しいAPI設計規範を作成できます。

新規API設計規範を作成する際、次の2つの選択肢があります。

サンプルテンプレート（推奨）
Apidogが提供するAPI設計規範のテンプレートを利用します。多くの場合、こちらの選択を推奨します。このテンプレートはOAS（OpenAPI仕様）に基づき、MicrosoftのAPI設計におけるベストプラクティスを参考に作成されています。

空のテンプレート
最低限の構成のみを備えたテンプレートです。詳細な内容は含まれていませんので、チーム独自のAPI設計規範を自由に記述できます。すでに独自の標準やベストプラクティスがある場合は、こちらの選択が適しています。

テンプレートを選択・プレビューし、内容を確認したうえで作成を確定すると、プロジェクト内に新しいAPI設計規範が作成されます。必要に応じて内容を自由にカスタマイズ可能です。作成した設計規範はフォルダツリーの最上部に表示され、チーム全員に仕様の重要性を周知できます。