最近、当社は PC 側、モバイル APP 側、およびモバイル Web 側でプロジェクトを開発しました。API インターフェイスによって返される JSON データ形式を設計するための一般的なベスト プラクティスはありますか?
現在、次のバージョンを見つけました
バージョン 1: 正常に実行されました: head ステータス コード:2XX
json {"id":51,"age":58,"name":"lifei"}
失敗した実行ヘッド ステータス コード:4XX-5XX {"message":"xxxxxx error","errors:{}}
バージョン 2: 成功および失敗した実行ヘッドのステータス コード:2xx
json {"コード":"0","メッセージ:"情報","データ":{}}
バージョン 3: 正常に実行されました: head ステータス コード:2XX
json {"id":51,"age":58,"name":"lifei"}
失敗した実行ヘッド ステータス コード:4XX-5XX {"コード":10001、"メッセージ":"xxxxxx エラー"、"エラー:{}}
ビジネスでさまざまな種類のエラーが発生した場合、たとえば、現金を引き出したい場合、銀行カードがバインドされていない、家計簿がアップロードされていない、ID カードがアップロードされていないなどのエラーが発生する可能性があります。 、携帯電話番号が拘束されていない、住所が記入されていない、残高がないなど、お待ちください。
巴扎黑2017-05-15 17:07:02
http://jsonapi.org/
https://github.com/interagent...
この種の仕様は比較的複雑ですが、一度覚えれば一生使えるもので、フロントエンドもバックエンドも簡単に再利用できます
独自の仕様を定義する利点はシンプルであることですが、設計中に多くの詳細が考慮されていない可能性があるため、修正が非常に面倒になります