記事ディレクトリ
インターフェイス設計仕様
フロントエンドとバックエンドを分離するためのインターフェース設計仕様は、次の点を参照できます。
RESTful API 設計スタイル: RESTful API は、HTTP プロトコルに基づく API 設計スタイルであり、HTTP 動詞 (GET、POST、PUT、DELETE など) を使用してリソースに対する操作を表し、URI を使用してリソース パスを表し、リクエストの結果などを示すHTTPステータスコード。このデザイン スタイルは、インターフェイスのデザインをより簡潔で明確にすることができます。
インターフェースのバージョン管理: インターフェースの互換性と保守性を確保するために、インターフェースをバージョン管理する必要があります。バージョン番号を URI に追加するか、HTTP ヘッダーを使用してバージョン情報を示すことができます。
パラメーターの送信方法: インターフェイスの設計では、GET、POST、PUT、DELETE などのパラメーターの送信方法と、パラメーターの形式 (JSON、XML、フォームなど) を指定する必要があります。
戻り値の形式: インターフェイスの戻り値は、ステータス コード、エラー メッセージ、データなどを含む統一された形式を使用する必要があります。複雑なデータ構造をうまく表現できる JSON 形式をお勧めします。
セキュリティに関する考慮事項: アイデンティティの検証、インターフェイスの権限制御、データの暗号化などを含むインターフェイスの設計では、セキュリティの問題を考慮する必要があります。
インターフェースの例:
ユーザー管理システムがあり、フロントエンドはユーザーリスト、ユーザーの詳細、ユーザーの追加、ユーザーの変更、ユーザーの削除などの機能を実装する必要があり、バックエンドは対応するインターフェースを提供するとします。
ユーザー リスト インターフェイス:
リクエスト方法：GET
URI：/api/v1/users
パラメータ: なし
戻り値:
{ "code": 200, "message": "success", "data": [ { "id": 1, "name": "Zhang San", "age": 20, "gender": "male" } , { "id": 2, "name": "Lisi", "age": 25, "gender": "female" } ] }
ユーザー詳細インターフェース:
リクエスト方法：GET
URI：/api/v1/users/{id}
パラメーター: id (ユーザー ID)
戻り値:
{ "code": 200, "message": "success", "data": { "id": 1, "name": "Zhang San", "age": 20, "gender": "male" } }
追加されたユーザー インターフェイス:
リクエスト方法：POST
URI：/api/v1/users
パラメータ:
{ "名前": "王武", "年齢": 30歳, "性別": "男" }
戻り値:
{ "コード": 200, "メッセージ": "成功", "データ": { "id": 3 } }
ユーザー インターフェイスを変更します。
リクエスト方法：PUT
URI：/api/v1/users/{id}
パラメータ:
{ "name": "Wang Wu", "age": 35, "gender": "male" }
戻り値:
{ "コード": 200, "メッセージ": "成功", "データ": null }
ユーザー インターフェイスを削除します。
リクエスト方法：DELETE
URI：/api/v1/users/{id}
パラメーター: id (ユーザー ID)
戻り値:
{ "コード": 200, "メッセージ": "成功", "データ": null }