最初に、現(xiàn)在の環(huán)境を取得します。 .phpという名前のファイルが存在する場合、ロードされます。そうしないと、デフォルトの構(gòu)成ファイルが読み込まれます。スリム固有の設(shè)定は$ config ['app']配列に保存され、基本的なスリムオブジェクトを拡張するアプリケーションのコンストラクターに渡されます（オプションですが推奨）。たとえば、ステートメント：

{
  "name": "yourname/my-contacts",
  "description": "Simple RESTful API for contacts management",
  "license": "MIT",
  "authors": [
    {
      "name": "Your Name",
      "email": "you@yourdomain.com"
    }
  ],
  "require": {
    "slim/slim": "*",
    "slim/extras": "*",
    "slim/middleware": "*",
    "monolog/monolog": "*",
    "j4mie/paris": "*",
    "flynsarmy/slim-monolog": "*"
  },
  "archive": {
    "exclude": ["vendor", ".DS_Store", "*.log"]
  },
  "autoload": {
    "psr-0": {
      "API": "lib/"
    }
  }
}

app/path/share/logs/envname_yyy-mm-dd.logのファイルに書き込むモノログロガーを構(gòu)成します。次に、いくつかの改善の後（ソースコードで表示できます）、生成されたログライターを取得し、データベースに接続しようとします。

<code>bootstrap.php
composer.json
README.md
bin/
    import
    install
lib/
    API/
public/
    .htaccess
    index.php
share/
    config/
        default.php
    db/
    logs/
    sql/
        data/
            contacts.sql
            users.sql
        tables/
            contacts.sql
            notes.sql
            users.sql
        ssl/
            mysitename.crt
            mysitename.key</code>

ルーティング構(gòu)造

<Directory>

  # Required for mod_rewrite in .htaccess
  AllowOverride FileInfo

  Options All -Indexes

  DirectoryIndex index.php index.shtml index.html

  <IfModule php5_module="">
    # For Development only!
    php_flag display_errors On
  </IfModule>

  # Enable gzip compression
  <IfModule filter_module="">
    AddOutputFilterByType DEFLATE application/json
  </IfModule>

  Order deny,allow
  Deny from all
  Allow from 127.0.0.1
</Directory>

<VirtualHost *:80>
  ServerAdmin you@yourdomain.com
  DocumentRoot "/path/to/MyApp/public"
  ServerName myapp.dev

  <IfModule rewrite_module="">
    RewriteEngine on

    ## Throw a 403 (forbidden) status for non secure requests
    RewriteCond %{HTTPS} off
    RewriteRule ^.*$ - [L,R=403]
  </IfModule>
</VirtualHost>

<IfModule ssl_module="">

  NameVirtualHost *:443

  Listen 443
  SSLRandomSeed startup builtin
  SSLRandomSeed connect builtin

  <VirtualHost *:443>
    ServerAdmin you@yourdomain.com
    DocumentRoot "/path/to/MyApp/public"
    ServerName myapp.dev

    SSLEngine on
    SSLCertificateFile /path/to/MyApp/share/ssl/mysitename.crt
    SSLCertificateKeyFile /path/to/MyApp/share/ssl/mysitename.key

    SetEnv SLIM_MODE development

  </VirtualHost>
</IfModule>

jsonミドルウェア

私の最初のアプローチは、認(rèn)証とJSONリクエスト /応答のために /V1グループ內(nèi)でルーティングミドルウェア（別のスリムミドルウェア）を使用することでしたが、クラシックミドルウェアを使用するためにより実用的で簡潔であることがわかりました。前述のように、ミドルウェアは、Slimmiddlewareから継承されたクラスのインスタンスです。スリムミドルウェアのcall（）メソッドは、操作がグローバルミドルウェアとしてリンクされている場合、$ app-＆gt; add（）メソッドを使用して自動的に実行されます。

<code>URL             HTTP Method  Operation
/api/contacts   GET          返回聯(lián)系人數(shù)組
/api/contacts/:id GET          返回 ID 為 :id 的聯(lián)系人
/api/contacts   POST         添加一個新聯(lián)系人并返回它（添加了 id 屬性）
/api/contacts/:id PUT          更新 ID 為 :id 的聯(lián)系人
/api/contacts/:id PATCH        部分更新 ID 為 :id 的聯(lián)系人
/api/contacts/:id DELETE       刪除 ID 為 :id 的聯(lián)系人

/api/contacts/:id/star PUT    將 ID 為 :id 的聯(lián)系人添加到收藏夾
/api/contacts/:id/star DELETE 從收藏夾中刪除 ID 為 :id 的聯(lián)系人

/api/contacts/:id/notes GET   返回 ID 為 :id 的聯(lián)系人的筆記
/api/contacts/:id/notes/:nid GET   返回 ID 為 :id 的聯(lián)系人的 ID 為 :nid 的筆記
/api/contacts/:id/notes POST  為 ID 為 :id 的聯(lián)系人添加新筆記
/api/contacts/:id/notes/:nid PUT   更新 ID 為 :id 的聯(lián)系人的 ID 為 :nid 的筆記
/api/contacts/:id/notes/:nid PATCH  部分更新 ID 為 :id 的聯(lián)系人的 ID 為 :nid 的筆記
/api/contacts/:id/notes/:nid DELETE 刪除 ID 為 :id 的聯(lián)系人的 ID 為 :nid 的筆記</code>

ルートパスをミドルウェアコンストラクターに渡すことができます。この場合、ミドルウェアがサイトのAPI部分にのみ適用されるように、 /API /V1を渡します?，F(xiàn)在のパスが応答コンテンツタイプのヘッダーと一致する場合、応答コンテンツタイプのヘッダーはアプリケーション/JSONに強制され、リクエスト方法を確認(rèn)します。要求方法が書き込みを有効にするリクエストメソッドの1つである場合（Put、Post、Patch）、リクエストコンテンツタイプのヘッダーはApplication/JSONでなければなりません。すべてが正常に機能する場合、ステートメント$ this＆gt; next＆gt; call（）は、チェーン內(nèi)の次のミドルウェアを?qū)g行します。

認(rèn)証

アプリケーションはデフォルトでHTTPSで実行されるため、基本認(rèn)証よりもトークンが優(yōu)先される方法を使用することにしました。APIキーは、基本的なHTTP認(rèn)証ヘッダーのユーザー名フィールドに送信されます（パスワードは不要））。これを行うために、既存のSlim httpbasicauthを変更することにより、Tokenoverbasicauthというスリムミドルウェアクラスを書きました。このミドルウェアはチェーンで最初に実行されるため、最後のものとして追加され、コンストラクターにオプションのルートパスパラメーターが必要です。

{
  "name": "yourname/my-contacts",
  "description": "Simple RESTful API for contacts management",
  "license": "MIT",
  "authors": [
    {
      "name": "Your Name",
      "email": "you@yourdomain.com"
    }
  ],
  "require": {
    "slim/slim": "*",
    "slim/extras": "*",
    "slim/middleware": "*",
    "monolog/monolog": "*",
    "j4mie/paris": "*",
    "flynsarmy/slim-monolog": "*"
  },
  "archive": {
    "exclude": ["vendor", ".DS_Store", "*.log"]
  },
  "autoload": {
    "psr-0": {
      "API": "lib/"
    }
  }
}

<code>bootstrap.php
composer.json
README.md
bin/
    import
    install
lib/
    API/
public/
    .htaccess
    index.php
share/
    config/
        default.php
    db/
    logs/
    sql/
        data/
            contacts.sql
            users.sql
        tables/
            contacts.sql
            notes.sql
            users.sql
        ssl/
            mysitename.crt
            mysitename.key</code>

APIは、可能であれば、使用可能な形式、できればJSON表現(xiàn)で有用なエラーメッセージを表示する必要があります。エラーコードとメッセージを含む最小ペイロードが必要です。さらに、検証エラーはより多くのセグメンテーションが必要です。 Slimを使用して、それぞれ$ app-＆gt; notfound（）および$ app-＆gt; error（）メソッドを使用して、404エラーとサーバーエラーを再定義できます。

<code>URL             HTTP Method  Operation
/api/contacts   GET          返回聯(lián)系人數(shù)組
/api/contacts/:id GET          返回 ID 為 :id 的聯(lián)系人
/api/contacts   POST         添加一個新聯(lián)系人并返回它（添加了 id 屬性）
/api/contacts/:id PUT          更新 ID 為 :id 的聯(lián)系人
/api/contacts/:id PATCH        部分更新 ID 為 :id 的聯(lián)系人
/api/contacts/:id DELETE       刪除 ID 為 :id 的聯(lián)系人

/api/contacts/:id/star PUT    將 ID 為 :id 的聯(lián)系人添加到收藏夾
/api/contacts/:id/star DELETE 從收藏夾中刪除 ID 為 :id 的聯(lián)系人

/api/contacts/:id/notes GET   返回 ID 為 :id 的聯(lián)系人的筆記
/api/contacts/:id/notes/:nid GET   返回 ID 為 :id 的聯(lián)系人的 ID 為 :nid 的筆記
/api/contacts/:id/notes POST  為 ID 為 :id 的聯(lián)系人添加新筆記
/api/contacts/:id/notes/:nid PUT   更新 ID 為 :id 的聯(lián)系人的 ID 為 :nid 的筆記
/api/contacts/:id/notes/:nid PATCH  部分更新 ID 為 :id 的聯(lián)系人的 ID 為 :nid 的筆記
/api/contacts/:id/notes/:nid DELETE 刪除 ID 為 :id 的聯(lián)系人的 ID 為 :nid 的筆記</code>

エラーはより単純ではありません：最初に要求されたメディアタイプを取得し、次に$ ISAPIフラグが現(xiàn)在のURLが /API /V*グループにあるかどうかを教えてくれます。クライアントがAPI URLを要求するか、JSONコンテンツタイプのヘッダーを送信した場合、JSON出力を返します。そうしないと、この例に示すようにテンプレートをレンダリングするか、靜的HTMLを印刷できます。他のエラーは少し注意が必要であり、$ app-＆gt; error（）メソッドが例外が発生したときにトリガーされ、標(biāo)準(zhǔn)のPHPエラーをErrorexceptionオブジェクトに変換します。セキュリティの脆弱性を回避するために、あまりにも多くの內(nèi)部メカニズムを公開することなく、クライアントに有用なエラーを提供する方法が必要です。このアプリケーションでは、2つのカスタム例外、ApiexceptionとapiexceptionValidationExceptionを作成しました。これらは一般に公開されます。他のすべての例外タイプはログにログに記録され、開発モードでのみ表示されます。

{
  "name": "yourname/my-contacts",
  "description": "Simple RESTful API for contacts management",
  "license": "MIT",
  "authors": [
    {
      "name": "Your Name",
      "email": "you@yourdomain.com"
    }
  ],
  "require": {
    "slim/slim": "*",
    "slim/extras": "*",
    "slim/middleware": "*",
    "monolog/monolog": "*",
    "j4mie/paris": "*",
    "flynsarmy/slim-monolog": "*"
  },
  "archive": {
    "exclude": ["vendor", ".DS_Store", "*.log"]
  },
  "autoload": {
    "psr-0": {
      "API": "lib/"
    }
  }
}

$ app-＆gt; error（）メソッドは、スローされた例外をパラメーターとして受信します。デフォルトでは、必要なすべてのデータを取得して$エラーアレイを入力します。その後、生産モードの場合は、プライベートデータを設(shè)定し、一般的なデータでメッセージを書き直します。 Custom ValidationExceptionクラスには、最終的なペイロードに追加された一連の検証エラーを返すカスタムgetData（）メソッドがあります。次に、リクエストに基づいてJSONまたはHTMLにエラーを表示します。 API側(cè)では、次のように簡単なエラーが発生します。

<code>bootstrap.php
composer.json
README.md
bin/
    import
    install
lib/
    API/
public/
    .htaccess
    index.php
share/
    config/
        default.php
    db/
    logs/
    sql/
        data/
            contacts.sql
            users.sql
        tables/
            contacts.sql
            notes.sql
            users.sql
        ssl/
            mysitename.crt
            mysitename.key</code>

<Directory>

  # Required for mod_rewrite in .htaccess
  AllowOverride FileInfo

  Options All -Indexes

  DirectoryIndex index.php index.shtml index.html

  <IfModule php5_module="">
    # For Development only!
    php_flag display_errors On
  </IfModule>

  # Enable gzip compression
  <IfModule filter_module="">
    AddOutputFilterByType DEFLATE application/json
  </IfModule>

  Order deny,allow
  Deny from all
  Allow from 127.0.0.1
</Directory>

<VirtualHost *:80>
  ServerAdmin you@yourdomain.com
  DocumentRoot "/path/to/MyApp/public"
  ServerName myapp.dev

  <IfModule rewrite_module="">
    RewriteEngine on

    ## Throw a 403 (forbidden) status for non secure requests
    RewriteCond %{HTTPS} off
    RewriteRule ^.*$ - [L,R=403]
  </IfModule>
</VirtualHost>

<IfModule ssl_module="">

  NameVirtualHost *:443

  Listen 443
  SSLRandomSeed startup builtin
  SSLRandomSeed connect builtin

  <VirtualHost *:443>
    ServerAdmin you@yourdomain.com
    DocumentRoot "/path/to/MyApp/public"
    ServerName myapp.dev

    SSLEngine on
    SSLCertificateFile /path/to/MyApp/share/ssl/mysitename.crt
    SSLCertificateKeyFile /path/to/MyApp/share/ssl/mysitename.key

    SetEnv SLIM_MODE development

  </VirtualHost>
</IfModule>

結(jié)論

FAQ（FAQ）のゼロからの休憩の構(gòu)築に関する

REST APIのエラーを処理する方法は？

REST APIでの正しいエラー処理により、その使いやすさと信頼性が向上します。 HTTPステータスコードを使用して、エラータイプを示します。エラーの詳細(xì)については、応答本體にエラーメッセージを含めてください。これにより、クライアントは何が間違っているのか、どのように問題を解決するかを理解するのに役立ちます。

REST APIをテストするにはどうすればよいですか？

REST APIをテストして、期待どおりに機能し、さまざまなシナリオを処理できることを確認(rèn)します。手動テストには、PostmanやCurlなどのツールを使用できます。自動テストについては、単體テスト、統(tǒng)合テスト、およびエンドツーエンドテストの使用を検討してください。モックサーバーを使用してAPI応答をシミュレートし、APIがさまざまな種類の応答を処理する方法をテストします。

私のREST APIを記録する方法は？

優(yōu)れたドキュメントにより、REST APIが理解し、使用しやすくなります。エンドポイント、要求方法、要求パラメーター、リクエスト例、応答ステータスコード、および応答の例に関する詳細(xì)情報が含まれています。 SwaggerやPostmanなどのツールを使用して、APIドキュメントを生成およびホストすることができます。

RESTFUL APIを設(shè)計する方法は？

設(shè)計RESTFUL APIには、リソース、エンドポイント、およびメソッドの計畫が含まれます。リソースには名詞と操作にはHTTPメソッドを使用します。 APIをシンプルで直感的に保ちます。ステータスコードを使用して、リクエストの結(jié)果を示します。 APIのステートレスを作成します。つまり、各リクエストには、リクエストを処理するために必要なすべての情報が含まれている必要があります。

私のREST APIで結(jié)果をページングする方法は？

ページングは??、単一の応答で返されるデータの量を制限するのに役立ちます。 「ページ」や「制限」などのクエリパラメーターを使用してページングを?qū)g裝できます。応答ヘッダーまたはボディにメタデータを含めて、現(xiàn)在のページ、ページの総數(shù)、アイテムの総數(shù)などを示します。

私のREST APIのレートを制限する方法は？

レート制限は、REST APIを亂用から保護し、公正な使用を保証します。 IPアドレス、APIキー、またはユーザーアカウントに基づいてリクエストの數(shù)を制限できます。 HTTPヘッダーを使用して、クライアントにレート制限ステータスを通知します。

私のREST APIを展開する方法は？

REST APIをサーバーまたはクラウドプラットフォームに展開できます。展開オプションを選択するときは、コスト、スケーラビリティ、セキュリティなどの要因を考慮してください。展開プロセスを自動化するために、継続的な統(tǒng)合と継続的配信（CI/CD）ツールを使用します。 APIのパフォーマンスと使用量を監(jiān)視して、ユーザーのニーズを満たしていることを確認(rèn)します。

以上がゼロからREST APIを構(gòu)築する：はじめにの詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國語 Web サイトの他の関連記事を參照してください。