Restful は、現在最も人気のあるインターフェイス設計仕様であり、インターフェイス開発の各プロセスで、
クライアント
がバックエンドと通信するときに使用する
プロトコルを定義します。API を介した -end サービス。HTTPS プロトコル
ドメイン名
API は専用のドメイン名でデプロイする必要があり、できるだけ単純にする必要があります。 API が非常に単純で、これ以上拡張されないことが確実な場合は、これをメイン ドメイン名の下に配置することを検討できます。一般的な URL ルートの例を 2 つ示します。
バージョン (バージョン管理)
内のすべての API は、下位互換性を維持する必要がありますが、古いバージョンの API が引き続き使用可能であることを確認する必要があります。
したがって、ルーティング (ルーター)
API
の特定の URL にバージョン サポート
アドレス (パス) を指定する必要がありますURL にハイフン (-) またはアンダースコア (_) を使用する必要があります。厳格なルールはありませんが、チームの状況に基づいたスタイルに準拠する必要があります
動詞 (リクエスト メソッド メソッド) は
、HTTP 動詞で表されるリソースの特定の操作タイプです。 。一般的に使用される HTTP 動詞は 5 つあります (括弧内は対応する SQL コマンドです)。
URL パラメータ
すべての URL パラメータはすべて小文字である必要があり、ページング パラメータは page および page_size に固定されている必要があります。
応答 (Response) は
適切な HTTP ステータス コードを選択する必要があります。
データは JSON 形式で返される必要があります。
すべてのエラーは均一にフォーマットされている必要があります。
一般的なステータス コード
error format
'message' => ':message', // エラーの詳細な説明 'errors' => ':errors', // パラメータ、422 およびその他のステータスのエラーの詳細な説明は 'code' => ' :code', // ビジネス定義の例外コード 'status_code' => ':status_code', // http ステータス コード 'debug' => ':debug', // デバッグ情報、非運用環境では
メッセージが
表示されます?
HTTP メッセージは、HTTP リクエストとレスポンスの際に情報を交換するために使用されます。クライアントからサーバーに流入するメッセージは、
リクエストメッセージとレスポンスメッセージの 2 つに分類されます
。リクエストメッセージとレスポンスメッセージの基本的なメッセージ構造は同じで、次の 3 つの部分で構成されます。
axios
互換のブラウザーおよびノードサーバーがブラウザーから XMLHttpRequest を作成します
Node.js からの http リクエストの作成は
Promise API をサポートします
リクエストとレスポンスのインターセプト、リクエスト データとレスポンス データの変換、リクエストのキャンセル、JSON の自動変換、XSRF に対する防御のためのデータ クライアントのサポートをサポートしています
(私は行き来することに慣れています。それを願っています!役に立つでしょう)
上記は、フロントエンドおよびバックエンドの通信で習得する必要がある核となる知識ポイントです。詳細については、php 中国語 Web サイトの他の関連記事にご注目ください。