Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

service-api-builder

muzichun29MIT1.3.1

api builder

react, api, service, generate, builder

readme

service-api-builder

自动生成api接口和对应ts类型

安装

npm i -g service-api-builder
yarn global add service-api-builder

使用说明:

api-build -u <url>

api-build -u http://www.domain.com/swagger/v1/swagger.json --ignore-header

参数

  • -u, --url :swagger地址 必填
  • -p, --path :生成文件存放目录 可选(默认/src/services)
  • --ignore-header :忽略header参数
  • --header-optional :header参数默认可选的(仅参数required为undefined时生效)
  • --query-optional :query参数默认可选的(仅参数required为undefined时生效)
  • --body-optional :body参数默认可选的(仅参数required为undefined时生效)

可添加apiHead.txt文件配置service文件头部代码,保存于执行命令的当前目录(一般为项目根目录)或者--path(生成文件存放目录)参数的目录,后者优先级高于前者。模板如下

import request from "../utils/request";
const url = "{apiUrl}";