# @jp-axios/api > A tool that automatically generates and encapsulates Axios according to swagger or OpenAPI Latest version **0.1.1** (published 2023-01-10) · MIT license · 0 weekly downloads ## Install ```sh npm install @jp-axios/api pnpm add @jp-axios/api yarn add @jp-axios/api bun add @jp-axios/api ``` Provides the command `jp-api`. ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities. Warnings: low downloads; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.1 | | Published | 2023-01-10 | | First published | 2022-04-06 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 3 | | Unpacked size | 107.7 KB | | Known vulnerabilities | 0 (+6 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 17 | | Author | jp-liu | | Maintainers | jpliu | | Keywords | swagger, swagger-ui, generate, generate-api, openAPI, codegen, jp-axios, axios, http, request | ## Links - npm: https://www.npmjs.com/package/@jp-axios/api - Repository: https://github.com/jp-liu/jp-axios - Homepage: https://github.com/jp-liu/jp-axios/packages/api/#readme - Issues: https://github.com/jp-liu/jp-axios/issues - npm.io page: https://npm.io/package/@jp-axios/api ## Dependencies (3) - [make-dir](https://npm.io/package/make-dir.md) ^3.1.0 - [@jp-axios/core](https://npm.io/package/@jp-axios/core.md) 0.1.1 - [swagger-typescript-api](https://npm.io/package/swagger-typescript-api.md) ^9.3.1 ## Alternatives - [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads - [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads - [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads - [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads - [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads ## Recent versions - 0.1.1 (latest) — 2023-01-10 - 0.1.0 — 2022-04-15 - 0.0.24 — 2022-04-12 - 0.0.23 — 2022-04-12 - 0.0.22 — 2022-04-12 - 0.0.21 — 2022-04-12 - 0.0.20 — 2022-04-12 - 0.0.19 — 2022-04-12 - 0.0.18 — 2022-04-12 - 0.0.17 — 2022-04-12 - 0.0.16 — 2022-04-12 - 0.0.15 — 2022-04-07 - 0.0.14 — 2022-04-07 - 0.0.6 — 2022-04-06 ## README # @jp-axios/api **@jp-axios/api** 是一个根据提供的配置, 自动生成 `API` 模块的工具. Generate api via swagger scheme. Supports OA 3.0, 2.0, JSON, yaml Generated api module [**@jp-axios/core**](https://github.com/jp-liu/jp-axios/tree/main/packages/core) to make requests. 非常简单的帮助你生成typeScript api模块 (支持 swagger2.0 和 OpenApi 3.0 规范) 玩得开心 ^_^ --- ## Why ![generate](https://user-images.githubusercontent.com/79979500/161927613-3a0cc0f6-d67b-40c9-882f-63e0f330f76e.jpg) ![jp-api](https://user-images.githubusercontent.com/79979500/161933386-04ad663e-843f-4ea5-a187-734890705195.gif) ## 安装 ```bash $ npm install @jp-liu/api --save-dev # or $ pnpm install @jp-liu/api --save-dev # or $ yarn add @jp-liu/api --save-dev ``` ## 如何使用 如果你没有全局安装, 那么可以使用 `npx` 或者 `pnpx` 工具辅助执行 ```bash $ npx jp-api # or $ pnpx jp-api ``` 你也可以将它加入你的 `package.json` 作为脚本命令 ```json { "scripts": { "jp-api": "jp-api", // ... } } ``` 也支持在 `node` 中, 扩展,自行运行 ```ts import { generate } from '@jp-liu/api' const config = { // ... } generate(config) ``` ## 配置信息 配置我们可以写在 `package.json` 中, 也可以在根目录创建 `jp-api.config.js/json` ```ts interface GenerateConfig { /** * swagger 文档地址,可以使`json`或`yaml`,输入绝对路径 */ input: string | ArrayInputOrOutputModel[] /** * url to swagger schema */ url: string | ArrayInputOrOutputModel[] /** * swagger schema JSON */ spec: import('swagger-schema-official').Spec /** * 生成输出路径 */ output: string | ArrayInputOrOutputModel[] /** * 是否覆盖,除`module`文件夹外的其他文件,默认:false * 其他文件都是提供的模板,会存在变更,所以默认不覆盖 * @default false */ overwrite?: boolean /** * 是否采用 `axios` 模板生成代码 * @default false */ useAxios?: boolean /** * `axios` 输出结果是否是 `res.data`,仅在 `useAxios` 为 `true` 时有效 * @default true */ unwrapResponse?: boolean /** * 多入口是否拆包: 后端分为多个模块，统一在网关对外暴露调用，前端开发针对后端模块分包，但仅仅只需要一个出口调用 * @tips 每一个入口是否生成一个模块 `useModule` * @default true */ splitApi?: boolean } ``` | 字段 | 描述( 入口支持数组形式 ) | | :-------- | ------------------------------------------------------------ | | input | 直接提供入口文件, 支持 `json` `yaml` 可以让后端生成, 参考入参一 | | url | 后端 `GitHub` 仓库地址, 或者是开启的 `swagger` 网页的接口信息, 参考入参二 | | overwrite | 默认值: **false**
是否覆盖基础模板, 由于提供的基础模板是会产生修改的部分, 如果接口更新,需要重新生成, 则由该开关控制是否将通用部分覆盖 | | useAxios | 是否采用 `axios` 模板生成代码 | | unwrapResponse | 是否将 `axios` 响应值解包, `res => res.data` | | splitApi | 默认值: **false**
多入口，是否对应多出口。
有时候后端分为多个模块，统一在网关对外暴露调用，前端开发针对后端模块分包，但仅仅只需要一个出口调用 | | output | 代码出口路径。example：`"./src/api"` | > 示例: > > 入参一: > > 当 `input` 为多个的时候, `dirName` 和 `path` 参数都是必传的, 我们需要知道他们是所处的模块. > > `output` 推荐输入一个,这样内部会帮你在同一文件夹导出不同模块的模板, 文件夹名字将会是 `input` 对应模块的 `dirName` > > ```json > { > "jp-api": { > // "input": "./src/api/swagger.json", // or "./src/api/swagger.yaml" > "input": [ > { > "dirName": "test1", > "path": "./src/api/swagger.json" > }, > { > "dirName": "test2", > "path": "./src/api/swagger.yaml" > } > ], > "output": "./src/api" > } > } > ``` > > 1. `json` 如: [swagger.json](https://github.com/jp-liu/jp-axios/blob/main/packages/api/src/test/swagger.json) > 2. `yaml` 如: [swagger.yaml](https://github.com/jp-liu/jp-axios/blob/main/packages/api/src/test/swagger.yaml) > > 入参二: > > ```json > { > "jp-api": { > // "url": "http://xxx:8080/xxx-server/v2/api-docs" // or 'git' > "url": [ > { > "dirName": "test1", > "path": "http://xxx:8080/xxx-server/v2/api-docs", > }, > { > "dirName": "test2", > "path": "http://xxx:8080/xxx-server/v2/api-docs1", > }, > ], > "output": "./src/api" > } > } > ``` > > `url`: `http://xxx:8080/xxx-server/v2/api-docs?`是后端同事开的 `swagger` 文档地址请求的 `api` 内容,如 > ![image](https://user-images.githubusercontent.com/79979500/161214860-4a593702-92fd-4325-837c-44aca2321a62.png) ## 任务清单 - [x] 0.`context`增加一个状态判定,是什么环境下使用,这样可以确定模板路径 - [x] 1.增加 `useAxios` 模板 - [x] 1.1 happy path 原有基础不变,增加一个 `useAxios` 判定 - [x] 1.2 进行重构,相同的部分抽取为 `base`,不同部分分为 `jp-axios` 和 `axios` - [x] 1.3 `module` 的模板需要支持 `axios` - [x] 1.4 `axios` 导出部分是否 `unwrapResponse` 解包,既 `res => res.data` - [x] 2.增加 `splitApi` 功能 - [x] 2.1 单入口为是否按模块导出, - [x] 2.1.1 `true` 按模块导出 - [x] 2.1.1 `false` 不按模块,生成单文件 - [x] 2.2 多入口为是否只生成一个实例调用 - [x] `true` 拆包,一个入口一个实例,一个文件夹 - [x] `false` 不拆包,多个入口,一个出口,一个实例,每个入口都是一个单文件 - [x] 不拆包生成文件名,也就是 `dirName`,单入口的时候,就是 `schema` --- _Source: https://npm.io/package/@jp-axios/api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._