API設定

🏗 Work in progress

The content of this page might not be fully up-to-date with Strapi 5 yet.

API呼び出しの一般的な設定は、./config/api.js ファイルで設定できます。

プロパティ	説明	タイプ	デフォルト
responses	グローバルなAPIレスポンスの設定	Object	-
responses.privateAttributes	グローバルに定義されたプライベートとして扱われる属性のセット	String array	[]
rest	REST API設定	Object	-
rest.prefix	APIのプレフィックス	String	/api
rest.defaultLimit	API呼び出しに使用されるデフォルトのlimitパラメータ（REST APIドキュメントを参照）	Integer	25
rest.maxLimit	limitとしてリクエストできる最大の許容数（REST APIドキュメントを参照）	Integer	100

✏️ Note

rest.maxLimitの値がrest.defaultLimitの値よりも小さい場合、maxLimitが使用される制限となります。

例:

JavaScript

./config/api.js

module.exports = ({ env }) => ({
  responses: {
    privateAttributes: ['_v', 'id', 'created_at'],
  },
  rest: {
    prefix: '/v1',
    defaultLimit: 100,
    maxLimit: 250,
  },
});

TypeScript

./config/api.ts

export default ({ env }) => ({
  responses: {
    privateAttributes: ['_v', 'id', 'created_at'],
  },
  rest: {
    prefix: '/v1',
    defaultLimit: 100,
    maxLimit: 250,
  },
});