- HTTPプロトコルに準拠: REST APIはHTTPプロトコルの仕様に準拠し、HTTPメソッド(GET、POST、PUT、DELETE)を使用してリソースを操作し、HTTPステータスコードを使用してリクエストの結果を示す必要があります。
- URIを使用してリソースを一意に識別する:各リソースに特定のリソースを表す一意のURIがあり、URIにはリソース間の関係を表す構造があるべきだ。
- 適切なHTTPメソッドを操作に使いわける:GETはリソースの情報の取得、POSTはリソースの作成、PUTはリソースの更新、DELETEはリソースの削除に利用する。
- HTTPステータスコードを使用してリクエストの結果を示す:REST APIは、リクエストの結果を示すHTTPステータスコード(200は正常、404はリソースが見つからない、400はリクエストが不正などを示す)を使用する必要があります。
- REST APIは、JSONやXMLなどの適切なデータ形式を使用してデータを転送する必要があります。
- バージョン管理を利用:REST APIはAPIの変更をバージョン管理して後方互換性を保つ必要がある
- 適切なエラーハンドリングメカニズムを提供する: REST APIはわかりやすいエラーメッセージを返せる適切なエラーハンドリングメカニズムを提供する必要があります。これにより、開発者は問題をすばやく特定できます。
- セキュリティ:REST API では、認証、認可などの適切なセキュリティ対策を実施し、リソースの安全性を保護する必要があります。
- キャッシュ性: REST APIはHTTPプロトコルのキャッシュメカニズムを活用した適切なキャッシュメカニズムを使用しパフォーマンスを向上させる必要があります。
- 拡張性:REST API は十分な拡張性を持っており、将来の需要の変化に対応可能に設計する必要があります。
✖