doclever-to-axios v1.1.0

doclever-to-axios

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

toc

介绍

基于 DOClever接口管理网站所导出的*.json类型的接口文件,快速生成使用axios作为请求函数的批量接口处理工具.该工具还提供查看接口更新的功能.

特性

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

环境要求

• Node >=8

安装

# 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