# doclever-to-axios

> 根据 doclever 导出的 json文件生成相应的 axios 接口

Latest version **1.1.0** (published 2020-04-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install doclever-to-axios
pnpm add doclever-to-axios
yarn add doclever-to-axios
bun add doclever-to-axios
```

Provides the command `dta`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2020-04-13 |
| First published | 2020-03-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 13 |
| Unpacked size | 31.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | xietf |
| Maintainers | xietf |

## Links

- npm: https://www.npmjs.com/package/doclever-to-axios
- Repository: https://github.com/xietianfu/doclever-to-axios
- Homepage: https://github.com/xietianfu/doclever-to-axios#readme
- Issues: https://github.com/xietianfu/doclever-to-axios/issues
- npm.io page: https://npm.io/package/doclever-to-axios

## Dependencies (13)

- [ora](https://npm.io/package/ora.md) ^4.0.3
- [chalk](https://npm.io/package/chalk.md) ^3.0.0
- [json5](https://npm.io/package/json5.md) ^2.1.1
- [colors](https://npm.io/package/colors.md) ^1.4.0
- [global](https://npm.io/package/global.md) ^4.4.0
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.3
- [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0
- [inquirer](https://npm.io/package/inquirer.md) ^7.0.5
- [commander](https://npm.io/package/commander.md) ^4.1.1
- [module-alias](https://npm.io/package/module-alias.md) ^2.2.2
- [lodash.isempty](https://npm.io/package/lodash.isempty.md) ^4.4.0
- [@types/inquirer](https://npm.io/package/@types/inquirer.md) ^6.5.0
- [inquirer-fuzzy-path](https://npm.io/package/inquirer-fuzzy-path.md) ^2.2.0

## Recent versions

- 1.1.0 (latest) — 2020-04-13
- 1.0.4 — 2020-03-26
- 1.0.3 — 2020-03-19
- 1.0.2 — 2020-03-19
- 1.0.1 — 2020-03-19
- 1.0.0 — 2020-03-19

## README

# doclever-to-axios

根据 doclever 导出的 json 文件生成相应的 axios 接口

[toc]

---

## 介绍

基于 [DOClever](http://www.doclever.cn/controller/index/index.html)接口管理网站所导出的`*.json`类型的接口文件,快速生成使用[axios](https://github.com/axios/axios)作为请求函数的批量接口处理工具.该工具还提供查看接口更新的功能.

## 特性

1. 自定义`json`文件获取目录
2. 自动读取所需`json`文件的最新版本
3. 完整的函数注释
4. 对比新老接口文件,获取接口更新内容

## 环境要求

- `Node >=8`

## 安装

```bash
# yarn
yarn global add doclever-to-axios

# npm
npm i -g doclever-to-axios
```

## 使用

`docLever-to-axios`会根据全局配置与该项目的`docLever.js`配置文件进行相关操作. 通过`dta --help || dta -h`查看该工具的简单操作

### 配置 api 文件下载地址

由于接口都需要下载到本地,然后才能执行一系列操作.通过`dta setDir`添加读取接口文件所在的目录,如果`dta init`生成的`dtaConfig.json`所添加的`downPath`与此不同,将以`downPath`为准.

注意: 设置地址下载地址需要使用绝对地址,像`~/downloads`这样的地址是没有办法进行地址拼接的,请使用`C:\\users\\{用户名}\\Downloads`的方式设置地址.

### 生成配置文件

在项目的根目录下使用`dta init`,该命令会在根目录生成配置文件`docLever.js`,如果配置文件已经存在,在`init`完成后将被覆盖.

初始化配置文件需要注意的点:

1. 建议将生成的配置文件添加到`.gitigonre`中,因为不同人项目的存放位置不同,绝对路径也不同,就会造成寻址失败.
2. 在填写 name 的时候尽量填写完整,提高正则的匹配率.使用`dta config paths`,其中`meetApiFiles`为匹配的文件名称.
3. 执行的第三步强制要求需要选择一个自定义后的`axios`配置文件,如果不需要自定义,还是建议新建一个配置文件,然后使用`export default axios`导出配置.
4. 生成的配置文件也可以在项目目录下面自定义,修改后,建议使用`dta config files`与`dta config paths`查看配置是否正确,各种地址与文件是否为你想到的.

### 查看文件变更

查看文件变更需要先`dta ben`,选择其中一个文件作为参考文件,该参考文件会与最新下载的接口文件做对比,然后执行`dta view`,会在原有配置的`outPath`路径下生成一个`change.md`的文档.

建议: 查看该 md 文档建议使用`Typora`编辑器查看,因为其有目录方便寻找.

### 文件清除

使用命令`dta clear`可以在完成当前版本之后,清除除最新的文件之前的所有文件,并将最新文件设置为参考文件供下一版本对比使用.

### 生成函数的使用

脚本生成的函数会存放在`dtaConfig.json`中`outPath`所指定的位置.所生成的函数有以下特点需要注意:

1. 函数的名称构成为: 请求方式+驼峰化(url-忽略的前缀)的结构.
2. 所有函数都放在对象`apiFetch`之中,所有调用接口函数的方式为:`apiFetch.接口名称(params)`.
3. 接口的`get`,`post`,`put`都统一处理了,使用方式都同上一点.这里需要注意`params`为对象.
4. 现在版本中暂时还支持修改`responseType`,后续会加上
5. `axios`的配置建议使用全局配置,现在暂时不支持为每个接口函数配置.

## 许可

MIT (c) TianFu Xie

---
_Source: https://npm.io/package/doclever-to-axios · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._