API 配置

¥API configuration

API 调用的常规设置可以在 ./config/api.js 文件中设置：

¥General settings for API calls can be set in the ./config/api.js file:

属性	描述	类型	默认
responses	全局 API 响应配置	目的	*
responses.privateAttributes	被视为私有的全局定义属性集。	字符串数组	[]
rest	REST API 配置	目的	*
rest.prefix	API 前缀	字符串	/api
rest.defaultLimit	API 调用中使用的默认 limit 参数（请参阅 REST API 文档）	整数	25
rest.maxLimit	可以请求的最大允许数量为 limit（参见 REST API 文档）。	整数	100

✏️ 注意

如果 rest.maxLimit 值小于 rest.defaultLimit 值，则 maxLimit 将作为使用的限制。

¥If the rest.maxLimit value is less than the rest.defaultLimit value, maxLimit will be the limit used.

示例：

¥Example:

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,
  },
});