API ガバナンスを見つけるにはどうすればよいですか?

スペック ファイルの編集を選択すると、いくつかの異なるビューが表示されます。その 1 つはガバナンスと呼ばれます。このビューでは、監査の結果が表示され、設定したルールに基づいて各警告またはエラーにコメントを提供できます。

API ガバナンスは何をするのに役立ちますか?

API のベスト プラクティスの重要なポイントは次のとおりです。

• 情報： 各 API に、タイトル、説明、その他の必要な情報などの重要なプロパティがあることを確認してください。

• バージョン管理: 各 API に対して標準のセマンティックまたは日付ベースのバージョン管理の使用を強制します。

• オペレーション： 個々の操作に概要、説明、ID が含まれていることを確認してください。

• パラメーター： パラメータ名の形式を標準化し、すべてのパラメータに適切な説明が付けられるようにします。

• 反応： API 全体で共通のステータス コード、メディア タイプ、スキーマ応答のセットを提唱します。

• スキーマ: JSON スキーマ コンポーネントを使用して、すべてのリクエストとレスポンスのスキーマを標準化します。

次は何ですか？

現在、という名前の基本的なルールがあります。OpenAPI Best Practice。将来的には、OWASP Top 10 Security やカスタム ルール セットなど、追加のルール セットを導入する予定です。今後の追加情報にご期待ください。

API ガバナンスには、設計と標準以上のものが含まれます。それは人々に力を与え、API の価値を最大化することを中心に展開しています。 API ガバナンスは、自動化、ワークショップ、トレーニング セッションを利用することで、ユーザーがセキュリティ対策、製品定義、実装戦略を開発できるように支援します。その有効性を確保するには、API ガバナンスのすべてのコンポーネントと影響を認識することが重要です。さらに詳しいガイダンスについては、Apigit ブログで重要な API ガバナンスのトピックに関する今後の投稿をご覧ください。