API設計規範 - Apidog Docs

利用には Apidog バージョン2.7.22以降が必要です。

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

Apidog の多くの機能（AI による「エンドポイント適合性チェック」や「AI命名」など）は、完全かつ明確に定義されたAPI設計ガイドラインを前提として機能します。標準化されたガイドラインを整備することで、次の効果が期待できます。

Apidog の各機能がより高い精度で動作

チーム内で設計原則が統一され、一貫性が担保される

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

新規作成時は、次の二つから選択できます。

サンプルテンプレート（推奨）

Apidog が提供する完成度の高いAPI設計ガイドラインテンプレートを利用します。多くのケースでこの選択が最適です。テンプレートは OAS（OpenAPI仕様）に基づき、Microsoft のAPI設計ベストプラクティスを参考に編纂されています。

テンプレート

仕様の基本骨子のみを提供します。詳細は含まれないため、チーム独自のAPI設計ガイドラインを一から記述できます。既に自社の標準やベストプラクティスが確立している場合に有効です。

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