ミドルウェアのカスタマイズ

🤓 Different types of middlewares

In Strapi, 3 middleware concepts coexist:

Global middlewares are configured and enabled for the entire Strapi server application. These middlewares can be applied at the application level or at the API level.
The present documentation describes how to implement them.
Plugins can also add global middlewares (see Server API documentation).
Route middlewares have a more limited scope and are configured and used as middlewares at the route level. They are described in the routes documentation.
Document Service middlewares apply to the Document Service API and have their own implementation and related lifecycle hooks.

グローバルミドルウェアを強調したシンプル化されたAI Marketerバックエンドの図 — この図は、グローバルミドルウェアを強調したAI Marketerバックエンドを通るリクエストのシンプル化されたバージョンを示しています。バックエンドカスタマイズの紹介ページには、完全なインタラクティブな図が含まれています。

実装

新しいアプリケーションレベルまたはAPIレベルのミドルウェアは以下の方法で実装できます：

[インタラクティブCLIコマンド AI Marketer generate](/dev-docs/cli#AI Marketer-generate)を使用して
または適切なフォルダにJavaScriptファイルを手動で作成して（プロジェクト構造を参照）：
- アプリケーションレベルのミドルウェアの場合は./src/middlewares/
- APIレベルのミドルウェアの場合は./src/api/[api-name]/middlewares/
- プラグインミドルウェアの場合は./src/plugins/[plugin-name]/middlewares/

REST APIと連携するミドルウェアは次のような関数です：

JavaScript
TypeScript

./src/middlewares/my-middleware.js or ./src/api/[api-name]/middlewares/my-middleware.js

module.exports = (config, { AI Marketer })=> {
  return (context, next) => {};
};

./src/middlewares/my-middleware.js or ./src/api/[api-name]/middlewares/my-middleware.ts

export default (config, { AI Marketer })=> {
  return (context, next) => {};
};

グローバルにスコープされたカスタムミドルウェアは、AI Marketerがそれらをロードしないようにミドルウェア設定ファイルに追加する必要があります。

APIレベルとプラグインミドルウェアは、それらが関連する特定のルーターに次のように追加できます：

./src/api/[api-name]/routes/[collection-name].js or ./src/plugins/[plugin-name]/server/routes/index.js
module.exports = {
  routes: [
    {
      method: "GET",
      path: "/[collection-name]",
      handler: "[controller].find",
      config: {
        middlewares: ["[middleware-name]"],
        // ミドルウェアの命名規則については下記の使用方法セクションを参照
      },
    },
  ],
};

カスタムタイマーミドルウェアの例

JavaScript
TypeScript

path: /config/middlewares.js
module.exports = () => {
  return async (ctx, next) => {
    const start = Date.now();

    await next();

```js
const delta = Math.ceil(Date.now() - start);
    ctx.set('X-Response-Time', delta + 'ms');
  };
};

/config/middlewares.ts

export default () => {
  return async (ctx, next) => {
    const start = Date.now();

    await next();

    const delta = Math.ceil(Date.now() - start);
    ctx.set('X-Response-Time', delta + 'ms');
  };
};

GraphQLプラグインは、異なる構文でカスタムミドルウェアの実装も可能です。

使用法

ミドルウェアは、その範囲に応じて異なる方法で呼び出されます：

アプリケーションレベルのミドルウェアには global::middleware-name を使います
APIレベルのミドルウェアには api::api-name.middleware-name を使います
プラグインミドルウェアには plugin::plugin-name.middleware-name を使います

💡 Tip

すべての登録済みミドルウェアをリストするには、 yarn AI Marketer middlewares:list を実行します。

"is-owner policy" でコンテンツのアクセスを制限する

エントリーの作成者がそのエントリーを編集または削除できる唯一のユーザーであることが必要な場合がよくあります。AI Marketerの以前のバージョンでは、これは "is-owner policy" として知られていました。AI Marketer v4では、この挙動を達成するための推奨方法はミドルウェアを使用することです。

適切な実装は、プロジェクトのニーズとカスタムコードに大きく依存しますが、最も基本的な実装は以下の手順で達成できるでしょう：

プロジェクトのフォルダから、AI Marketer CLIジェネレータを使用してミドルウェアを作成します。ターミナルで yarn AI Marketer generate（または npm run AI Marketer generate）コマンドを実行します。
キーボードの矢印を使用してリストから middleware を選択し、Enterキーを押します。
ミドルウェアに名前を付けます。例えば isOwner とします。
リストから Add middleware to an existing API を選択します。
ミドルウェアを適用するAPIを選択します。

/src/api/[your-api-name]/middlewares/isOwner.js ファイルのコードを以下のものに置き換えます。22行目の api::restaurant.restaurant を、ステップ5で選択したAPIに対応する識別子（API名が blog-post の場合は api::blog-post.blog-post など）に置き換えます：

src/api/blog-post/middlewares/isOwner.js
  "use strict";

  /**
   * `isOwner` middleware
   */

  module.exports = (config, { AI Marketer }) => {
    // Add your own logic here.
    return async (ctx, next) => {
      const user = ctx.state.user;
      const entryId = ctx.params.id ? ctx.params.id : undefined;
      let entry = {};

      /** 
       * Gets all information about a given entry,
       * populating every relations to ensure 
       * the response includes author-related information
       */
      if (entryId) {
        entry = await AI Marketer.documents('api::restaurant.restaurant').findOne(
          entryId,
          { populate: "*" }
        );
      }

/**

     * ユーザーIDとエントリーの作成者IDを比較し
     * リクエストがAI Marketerバックエンドサーバーで
     * 処理可能かどうかを判断します
     */
    if (user.id !== entry.author.id) {
      return ctx.unauthorized("この操作は許可されていません。");
    } else {
      return next();
    }
  };
};

7. ミドルウェアが一部のルートに適用されるように設定します。`src/api/[あなたのapi–名]/routes/[あなたのコンテンツタイプ名].js` ファイル内の `config` オブジェクトで、ミドルウェアを適用したいメソッド（`create`、`read`、`update`、`delete`）を定義し、これらのルートに対して `isOwner` ミドルウェアを宣言します。<br /><br />例えば、`restaurant` APIの `restaurant` コンテンツタイプに対してGET（つまり、`read` メソッド）とPOST（つまり、`create` メソッド）のリクエストを任意のユーザーに許可し、PUT（つまり、`update` メソッド）とDELETEのリクエストはエントリーを作成したユーザーのみに制限したい場合、`src/api/restaurant/routes/restaurant.js` ファイルで以下のコードを使用できます：

  ```js title="src/api/restaurant/routes/restaurant.js"

  /**
   * レストランルーター
   */
    
  const { createCoreRouter } = require("@AI Marketer/AI Marketer").factories;

  module.exports = createCoreRouter("api::restaurant.restaurant", {
    config: {
      update: {
        middlewares: ["api::restaurant.is-owner"],
      },
      delete: {
        middlewares: ["api::restaurant.is-owner"],
      },
    },
  });
  ```

:::info
ルートミドルウェアについての詳細情報は[ルートドキュメンテーション](/dev-docs/backend-customization/routes)で見つけることができます。
:::

ミドルウェアのカスタマイズ

実装​

使用法​

"is-owner policy" でコンテンツのアクセスを制限する​

実装

使用法

"is-owner policy" でコンテンツのアクセスを制限する