# generata-api

**Repository Path**: xmfdev/generata-api

## Basic Information

- **Project Name**: generata-api
- **Description**: 根据 apiDocs 生成 api 部分代码
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-01-23
- **Last Updated**: 2025-05-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# @xdp/generate-api

> 根据 apiDocs 生成api部分代码

## Usage

### 安装命名

```bash
# npm 安装
npm install -g @xdp/generate-api
```

### 添加配置文件

在config文件夹下创建api-config.js

```js
// config/api-config.js
module.exports = [
  {
    key: 'apiName', // proxy-config中的apiName
    target: 'name', // apiDocs所在路径
    dir: 'name', // 生成代码在src/api的文件夹名称
    beforeRequest: ()=> { // 非必填， 当获取json时需要登录地址时可配， 需要返回请求文档时的配置 如 { cookie: 'token'}

    } 
  }
]

```

### 生成api代码

```bash
# 在项目根目录执行
gen-api

```

### 锁定生产后修改过的文件

在文件的第一行添加`@locked`注释即可