Astrill客户端是一个用于构建基于REST的客户端框架，允许开发者在Web服务器上快速创建客户端。以下是Astrill客户端的常见配置方式

基本配置

1 安装

将Astrill安装到node_modules路径中：

npm install

2 配置文件

配置文件通常放在app/config/路径下,常见的配置文件包括：

• app.ts：用于配置客户端的访问权限和配置。
• app.js：用于配置前端和后端的API端点。

3 配置文件的结构

配置文件通常包含以下部分：

• 访问控制：设置访问权限,允许哪些用户访问客户端。
• 端点配置：定义前端和后端的API端点，包括端点路径、名称、参数和响应。
• 头部提示：设置前端提示信息的位置和内容。

基本配置示例

1 配置文件示例

前端端（app.ts）：

import { Config } from '@astrill/client';
import { ConfigConfig } from 'config-config';
import { Open } from 'https://open';
const ConfigConfig = new ConfigConfig({ 
  open: Open('https://localhost:8'),
  allow: ['GET', 'POST'],
  secret: 'api-key',
});
export const Config = new Config(ConfigConfig);
export default Config({
  body: 'Astrill client',
  port: 88,
  secret: 'api-key',
  api: Open('https://localhost:8'),
  port: 88,
  use: 'https://localhost:88',
  skip: 1
});

后端端（app.js）：

import { Config } from '@astrill/client';
const Config = new Config({
  ports: ['8'],
});
export default Config({
  path: '/api',
  name: 'api',
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
  },
  body: 'Hello API!'
});

必要配置

1 访问权限

• 前端：允许哪些请求？（使用allowed参数）
  • allowed: ['GET', 'POST']：允许前端请求
  • allowed: ['GET', 'POST', 'PUT']：允许前端请求
• 后端：允许哪些请求？（使用allowed参数）
  • allowed: ['GET', 'POST']：允许后端请求
  • allowed: ['GET', 'POST', 'PUT']：允许后端请求
• 开发者：设置开发者权限
  • controller: ['POST']：开发者可以执行POST请求

2 端点配置

• 前端端：
  • api：前端API的路径和名称
  • GET：前端请求类型
• 后端端：
  • api：后端API的路径和名称
  • GET：后端请求类型

3 头部提示

• 前端端：
  • head：前端提示信息的位置（/api（"Welcome to API"）
• 后端端：
  • head：后端提示信息的位置（/api（"API available at /api"）

配置文件模式

配置文件（如app.ts和app.js）是客户端的核心文件，可以轻松配置访问权限、API端点和头部提示。

配置文件模式示例

1 配置文件示例

前端端（app.ts）：

import { Config } from '@astrill/client';
import { ConfigConfig } from 'config-config';
import { Open } from 'https://open';
const ConfigConfig = new ConfigConfig({ 
  open: Open('https://localhost:8'),
  allow: ['GET', 'POST'],
  secret: 'api-key',
});
export const Config = new Config(ConfigConfig);
export default Config({
  body: 'Astrill client',
  port: 88,
  secret: 'api-key',
  api: Open('https://localhost:8'),
  port: 88,
  skip: 1
});

后端端（app.js）：

import { Config } from '@astrill/client';
const Config = new Config({
  ports: ['8'],
});
export default Config({
  path: '/api',
  name: 'api',
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
  },
  body: 'Hello API!'
});

高级配置

1 访问权限过滤

• 部署后，前端端和后端端需要设置访问权限。

  allowed: ['GET', 'POST'],

2 API日志

• API日志可以通过log参数设置，用于监控API请求和响应。

  log: 'api.log',
  level: 'WARNING',
  content: 'API日志信息',
  every: 1, // 每每隔1秒输出一次
  append: false,
  content: 'API日志内容',
  format: 'json'

3 路径配置

• 设置API的路径，
  • 后端端：api，路径 /api
  • 前端端：api，路径 /api

4 部署配置

• 网站的API端点可以部署到不同的服务器，
  • 虚机：https://localhost:8/v1
  • 服务器：http://localhost:8/v1

首重配置

1 使用配置文件

配置文件通常是app/config/路径下，例如app.ts或app.js，通常使用config-config库配置文件。

2 配置文件模式

配置文件通常用于配置访问权限、API端点和头部提示，使用open、get、delete或put请求。

常见配置模式

1 文件模式

• 使用文件模式配置，

  import { Config } from '@astrill/client';
  import { ConfigConfig } from 'config-config';
  import { Open } from 'https://open';

const ConfigConfig = new ConfigConfig({ open: Open('https://localhost:8'), allow: ['GET', 'POST'], secret: 'api-key', });

export const Config = new Config(ConfigConfig);

export default Config({ body: 'Astrill client', port: 88, secret: 'api-key', api: Open('https://localhost:8'), port: 88, skip: 1 });

#### 8.2 配置文件模式示例
```typescript
import { Config } from '@astrill/client';
import { ConfigConfig } from 'config-config';
import { Open } from 'https://open';
const ConfigConfig = new ConfigConfig({ 
  open: Open('https://localhost:8'),
  allow: ['GET', 'POST'],
  secret: 'api-key',
});
export const Config = new Config(ConfigConfig);
export default Config({
  body: 'Astrill client',
  port: 88,
  secret: 'api-key',
  api: Open('https://localhost:8'),
  port: 88,
  skip: 1
});

常见配置

1 访问权限

• 开发者：允许开发者执行POST请求

  controller: ['POST'],
  required: true,

2 端点配置

• 前端端：
  • api：API的路径和名称
  • GET：前端请求类型
• 后端端：
  • api：API的路径和名称
  • GET：后端请求类型

3 头部提示信息

• 前端端：

  head: 'App Name', 
  content: 'Welcome to the API',

• 后端端：

  head: '/api', 
  content: 'API available at /api',

Astrill客户端允许