\r\n English | 简体中文\r\n
\r\n\r\n[](https://www.npmjs.com/package/axios-annotations)\r\n[](https://github.com/sitorhy/axios-annotations/blob/master/LICENSE)\r\n\r\n---\r\nQuick Configuration Framework for Axios with TypeScript support.\r\n\r\n> 声明式`API`配置工具。将 **请求的构建声明** 与 **业务数据的提供** 完全分离。不再手动拼装 `URL`\r\n、请求头和请求体，而是通过装饰器来“声明”一个请求应该如何被构建。\r\n\r\n# 装饰器可用范围\r\n\r\n| 装饰器 | 可用范围 | 描述 |\r\n|:------------------|:-------|:--------------------------|\r\n| `@RequestConfig` | 类 / 方法 | 设置请求配置（例如 `signal`）。 |\r\n| `@RequestMapping` | 类 / 方法 | 定义 `URL` 路径和 `HTTP` 请求方法。 |\r\n| `@RequestWith` | 方法 | 重定向请求方法使用的配置。 |\r\n| `@RequestBody` | 方法 | 标记一个参数作为请求体。 |\r\n| `@RequestHeader` | 方法 | 标记一个参数作为请求头。 |\r\n| `@RequestParam` | 方法 | 标记一个参数作为 `URL` 查询参数。 |\r\n| `@PathVariables` | 方法 | 标记一个参数作为 `URL` 路径变量。 |\r\n\r\n---\r\n\r\n# Usage\r\n\r\n## 流程简述\r\n\r\n+ **声明式构建**：使用 `@RequestMapping`, `@RequestParam` 等装饰器来描述一个请求的静态结构。\r\n+ **提供数据源**：业务方法接收参数，并 `return` 一个由这些参数组装成的普通 `JavaScript`\r\n 对象。这个对象将作为所有装饰器的数据源 (`Data Source`)。\r\n+ **自动执行**：框架会拦截方法调用，使用装饰器定义的规则，从返回的数据源对象中提取数据，自动构建并执行请求。\r\n\r\n## 创建配置\r\n\r\n框架内置默认的全局配置，默认指向本地的`8080`端口，但建议自行创建和管理配置。\r\n例：\r\n\r\n```ts\r\n// config.ts\r\nimport {Config} from \"axios-annotations\";\r\n\r\nexport const localConfig = new Config({\r\n protocol: 'http',\r\n host: 'localhost',\r\n prefix: '', // 请求前缀，可选\r\n port: 5173\r\n});\r\n```\r\n\r\n通过 `@RequestConfig` 注入服务类，注意服务类需要继承 `Service`。\r\n\r\n```ts\r\nimport {localConfig} from \"./config.ts\";\r\nimport {Service, RequestConfig} from \"axios-annotations\";\r\n\r\n@RequestConfig(localConfig)\r\nexport class DemoService extends Service {\r\n // ...\r\n}\r\n```\r\n\r\n请求前缀可以在 `Config` 的 `prefix` 中指定，或者使用 `@RequestMapping` 指定前缀。\r\n\r\n## @RequestMapping\r\n\r\n+ 声明服务使用的统一请求前缀。\r\n+ 声明业务方法的请求方法和请求路径，注解方法的时候第二参数必填。\r\n\r\n```ts\r\nimport {localConfig} from \"./config.ts\";\r\nimport {Expect, Service, RequestConfig, RequestMapping} from \"axios-annotations\";\r\n\r\n@RequestConfig(localConfig)\r\n@RequestMapping(\"/api\")\r\nexport class DemoService extends Service {\r\n // [GET] http://localhost:5173/api/foo\r\n @RequestMapping(\"/foo\", \"GET\")\r\n foo() {\r\n return ExpectAbortController Demo
\r\n开发环境下只有第二次挂载的请求会被接收
\r\n