安全で予測可能なAPI操作のためには、どのようなデータが受信され、返されるかを厳密に制御する必要があります。JSONスキーマのサポートを実装しています。これは、サーバー側とクライアント側でリクエストとレスポンスを自動的に検証できるデータ構造の正式な説明です。
JSONスキーマは、統合エラーの特定、不安定な動作の排除、システム間の相互運用性の確保、API相互運用性の向上を支援します。
JSONスキーマが与えるもの
| オポチュニティ | 提供するもの |
|---|---|
| 構造チェック | オブジェクトが期待されるフィールドとタイプと一致していることを確認します |
| 必須フィールド | クリティカル属性制御 |
| Typification（タイピング） | 数値、文字列、ブール値、配列の明確なチェック |
| 制約と書式 | 最小/最大長、列挙、パターン、電子メール形式などのサポート。 |
| ［再利用］ | テンプレートと再利用可能なコンポーネントの作成 |
検証の仕組み
1.リクエストまたはレスポンスは、定義済みスキーマと比較されます
2.偏差がある場合、APIは説明付きのエラーを返します
3.スキーマのマージ、継承、条件付きルールの使用
4.任意のレベルで適用可能： クエリ、本文、ヘッダー、クエリパラメータ
APIとクライアントのメリット
不正確で悪意のあるデータに対する保護
統合の安定性と行動の予測可能性を向上
回路ベースのモックの自動テストと生成
ドキュメントおよびSwagger/OpenAPIでスキーマを使用できる
APIサポートとスケーリングを簡素化
特に関連する場合
外部統合とパートナーAPIを備えたプラットフォーム
明確な応答構造を待っているモバイルおよびフロントエンドアプリケーション
自動APIテストによるCI/CDパイプライン
パラメータとコントラクトを動的に変更するシステム