ホーム>Web デザインのチュートリアル>JavaScript チュートリアル

これらの核となる知識ポイントは、フロントエンドとバックエンドの通信で習得する必要があります。

著者：Eve Cole 更新時間：2022-08-10 14:54:24

休息とは何ですか？

Restful は、現在最も人気のあるインターフェイス設計仕様であり、インターフェイス開発の各プロセスで、

クライアント

がバックエンドと通信するときに使用する

プロトコルを定義します。

API を介した -end サービス。HTTPS プロトコル

ドメイン名

API は専用のドメイン名でデプロイする必要があり、できるだけ単純にする必要があります。 API が非常に単純で、これ以上拡張されないことが確実な場合は、これをメイン ドメイン名の下に配置することを検討できます。一般的な URL ルートの例を 2 つ示します。

  • api.example.com/* 別のサブドメイン名が使用されます。インターフェイス
  • example.com/api にアクセスします。 /* メイン ドメイン名の単一スペース

バージョン (バージョン管理)

内のすべての API は

、下位互換性を維持する必要がありますが、古いバージョンの API が引き続き使用可能であることを確認する必要があります。

したがって、

ルーティング (ルーター)

API

の特定の URL に

バージョン サポート

アドレス (パス) を指定する必要があります
    。URL
  • の名前はすべて小文字にする必要があります
  • 。URL 内のリソース (リソース) の名前は名詞である必要があります。
  • 残りの形式の URL を最初に使用する必要
  • があります
  • 。読みやすい
  • URL である必要があり、

URL にハイフン (-) またはアンダースコア (_) を使用する必要があります。厳格なルールはありませんが、チームの状況に基づいたスタイルに準拠する必要があります

  • https://api.example.com/zoos
  • https://api.example.com/animals
  • https://api.example .com/zoos/{zoo}/animals
  • https://api.example.com/animal_types
  • https://api.example.com/employees

動詞 (リクエスト メソッド メソッド) は

、HTTP 動詞で表されるリソースの特定の操作タイプです。 。一般的に使用される HTTP 動詞は 5 つあります (括弧内は対応する SQL コマンドです)。

  • GET (SELECT): サーバーからリソース (1 つ以上の項目) を取得します。
  • POST (CREATE): サーバー上に新しいリソースを作成します。
  • PUT (UPDATE): サーバー上のリソースを更新します (クライアントは変更後の完全なリソースを提供します)。
  • PATCH (UPDATE): サーバー更新リソース (クライアントが変更された属性を提供) 部分を更新します。
  • DELETE (DELETE): サーバーからリソースを削除します。

URL パラメータ

すべての URL パラメータはすべて小文字である必要があり、ページング パラメータは page および page_size に固定されている必要があります。

応答 (Response) は

適切な HTTP ステータス コードを選択する必要があります。
データは JSON 形式で返される必要があります。
すべてのエラーは均一にフォーマットされている必要があります。

一般的なステータス コード

  • 1xx は、リクエストが受け入れられ、処理を続行する必要があることを意味します。2xx
  • は通常、リクエストが成功したことを意味し、リクエストによって予期された応答ヘッダーまたはデータ本体が返されます。
    • 200. サーバーはユーザーが要求したデータを正常に返します。
    • 201 ユーザーはデータの新規作成または変更に成功しました
      • 。
    • 202 リクエストがバックグラウンド キューに入ったことを意味します (成功した場合は戻り値はなく、非同期です)
    • 204 削除が成功しました
  • 。リダイレクト
  • 4xx クライアントの理由によるエラー
    • 404 要求されたインターフェイスが存在しません、エラーの種類 (要求アドレスが間違っています)
    • 401 ユーザーが
    • ログインしていません 403 ユーザーはログインしていますが、アクセスする権限がありません
    • 422 クライアント パラメータ エラー、検証エラー
    • 429 リクエスト制限を超えました
  • 5xx サーバー側の理由により発生したエラー
    • 500 サーバーで予期しない状況が発生したため、リクエストを完了できませんでした。 処理中、サーバー コードが
    • エラーを報告しました 503。 サーバーはメンテナンス中です。
    • 504 タイムアウト。 call

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 サイトの他の関連記事にご注目ください。
関連記事