# zen-api-parser > zen api 配置文件解析器 Latest version **0.0.11** (published 2020-10-05) · MIT license · 0 weekly downloads ## Install ```sh npm install zen-api-parser pnpm add zen-api-parser yarn add zen-api-parser bun add zen-api-parser ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned. ## Facts | | | |---|---| | Version | 0.0.11 | | Published | 2020-10-05 | | First published | 2018-12-13 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 3 | | Unpacked size | 11.6 KB | | Known vulnerabilities | 0 (+6 in 2 direct dependencies) | | Install scripts | no | | GitHub stars | 0 | | Author | zenheart | | Maintainers | zenheart | | Keywords | zen-mock, api, config, parser | ## Links - npm: https://www.npmjs.com/package/zen-api-parser - Repository: https://github.com/zenHeart/zen-mock/tree/master/packages/zen-api-parser - Homepage: https://github.com/zenheart/zen-mock#readme - Issues: https://github.com/zenheart/zen-mock/issues - npm.io page: https://npm.io/package/zen-api-parser ## Dependencies (3) - [mockjs](https://npm.io/package/mockjs.md) ^1.1.0 - [convict](https://npm.io/package/convict.md) ^4.4.1 - [deepmerge](https://npm.io/package/deepmerge.md) ^3.3.0 ## Alternatives - [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads - [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads - [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads - [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads - [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads ## Recent versions - 0.0.11 (latest) — 2020-10-05 - 0.0.10 — 2020-07-28 - 0.0.9 — 2019-03-31 - 0.0.8 — 2018-12-21 - 0.0.7 — 2018-12-21 - 0.0.6 — 2018-12-20 - 0.0.5 — 2018-12-19 - 0.0.4 — 2018-12-18 - 0.0.1 — 2018-12-13 ## README zen-api-parser ==== **zen-mock 配置解析器** ------ ## 项目说明 用于 [zen-mock](../zen-mock/README.md) 项目,解析 api 配置. 支持合法的 `json,js` 配置文件. ## 安装 ```bash npm i zen-api-parser ``` ## 快速入门 参看示例 [basic](./examples/basic/README.md) ## 配置详述 zen-api-parser 会采用 `require` 直接读取配置. 默认解析遵循如下约定.更详细的解析参见 [原理浅析](#原理浅析) * 读取配置文件不包含合法配置项,则整个配置作为 resp.body * 读取配置文件为函数,直接作为 resp 配置 * 合法的配置文件,配置项如下 配置项|是否可选|类型|作用 :---|:---|:---|:---| **req**|可选|Object|配置请求对象 **req.method**|可选|String|默认 get 请求,支持所有合法 http 请求,**注意采用小写** **req.path**|可选|String|设置请求路径,默认值为配置文件相对配置根目录对应的路径 **req.header**|可选|Object|配置请求头,支持采用 mockjs 设置参数,例如 `{token:/\d{11}/}` 设置 token 的请求头,配置符合 [express set](http://expressjs.com/en/4x/api.html#res.set) 中传入对象的风格 **req.params**|可选|Object|设置请求路径中携带的参数,支持 mockjs 模式模拟数据 **req.query**|可选|Object|设置请求查询字段,支持 mockjs 模式模拟数据 **req.body**|可选|*|设置请求体,支持 mockjs 模式模拟数据 **resp**|必选|*|分为如下情况 **resp.header**|可选|Object|设置响应头,支持 mockjs 模式模拟数据 **resp.body**|可选|*|设置响应体,支持 mockjs 模式模拟数据 > 注意请求配置结合 [zen-mock-cli](https://github.com/zenHeart/zen-mock/tree/master/packages/zen-mock-cli) > 会格外有用,作为 mock-server 一般配置 `path,method` 即可 ## 原理浅析 默认解析规则如下,**只对核心流程进行描述,详细逻辑请查看源码** 1. 采用 require 读取 api 配置文件 2. 若存在 req,resp 配置字段则解析配置 1. 传入 req 给 [request](./lib/request.js) 解析 1. 合并默认配置 2. 未配置 path,则结合配置文件目录和配置根目录生成默认路径 > 文件名为 `index` 则忽略文件名只采用相对配置目录的路径作为 path. 3. mock 相关数据并返回处理后的 req 对象 2. 传入 resp 给 [respond](./lib/respond.js) 解析 1. 根据传入类型做响应处理 * resp 为函数则直接返回该函数并在函数上附带解析后的配置参数 * 非函数则包装后返回 express 处理函数 2. 返回 epxress 请求处理函数,并合并配置到返回的处理函数上 3. 若没有 req 字段则,将整个配置传入 [respond](./lib/respond.js) 进行解析 4. 处理完成后返回形如 ```js { req:{ path:"/foo", //... }, resp:function(req,res) { //... } } ``` 的对象 --- _Source: https://npm.io/package/zen-api-parser · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._