# YAP2JS

**Repository Path**: debby-echo/YAP2JS

## Basic Information

- **Project Name**: YAP2JS
- **Description**: YAPI转前端API
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 0
- **Created**: 2020-04-17
- **Last Updated**: 2023-02-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# YAPI2JS 

>基于`nodejs`的`YAPI`转换成前端`API`代码的转化工具

**生成的示例是我们自己公司基于`axios`二开开发框架，使用时候需要自定义一下**

>可能会遇到YAPI中定义的一些奇奇怪怪的接口（接口地址、名称等等）或者一些别的异常没有处理，要是遇到了请修改api.ts文件哦

## 目标

>自动构建`yapi`-`js`代码

**让前端开发更加的关心`UI`与交互**

**src为生成前端api的目录，后续会增加生成到指定目录**

## 依赖
```
package.json
```

## 使用

```
npm install
npm run start
```

## 需要
```
yapi的登录账号和密码

yapi对应项目的pid，在url中也可以看见
```

## 例子

```nodejs
const API = require('./api')

interface InterfaceLoginData {
    email: string;
    password: string
}

// YAPI地址
const host: string = 'http://106.54.200.91:8080'

const pid: number = 11

const loginData: InterfaceLoginData =  {
    email: 'admin@admin.com',
    password: 'admin@123'
}

// 初始化
const YAIPI_INSTANCE = new API(host, pid)


// 登录
YAIPI_INSTANCE.login(loginData).then(() => {
    // 开始转化任务
    YAIPI_INSTANCE.startTask()

    // 如果您要自定义的去处理它 请使用
    // YAIPI_INSTANCE.startTask((body) => {
    //     console.log(body)
    //     // your convert code can write
    // })
})

```


## v1.0.0

1. 实现了对yapi swigger postman等接口自动转换成前端接口代码的转换
2. 实现了用户自定义转换，YAPI向用户提供从YAPI获取的接口JSON