# yapi-tool

**Repository Path**: qdzhs/yapi-tool

## Basic Information

- **Project Name**: yapi-tool
- **Description**: 根据yapi接口平台中的接口，生成本地调用的接口方法文件，省去每个接口都要在文件中手动录入的时间，大大提升开发效率
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 23
- **Forks**: 8
- **Created**: 2021-08-11
- **Last Updated**: 2025-09-02

## Categories & Tags

**Categories**: api-gateway

**Tags**: 提效工具, yapi

## README

### 使用

#### 1.安装

```js
npm i yapi-tool -g
```

#### 2.初始化mock-config.js文件【各配置项参见生成的该文件说明】

```js
yapi-tool init
```

#### 3.按说明配置mock-config.js文件

#### 4.生成接口文件

```js
yapi-tool gen
```

#### 5.查看使用教程【推荐】

```js
npm run docs-dev
```

###### 5.1 文档启动后访问，查看相关配置详细说明

###### 5.2 最终的生成效果，也可查看example文件夹

#### 6.构建使用教程

```js
npm run docs-build
```

### 目录释意

#### bin

命令处理

#### config

接口下载后解析的一些默认配置项

#### const

一些常量

#### src

接口下载主要逻辑

#### utils

一些工具方法


### 说明

> 初次生成接口文件后可修改文件名称自行使用，后续接口变更生成的接口文件最好是将新接口方法复制到现有的接口文件中。