# api-builder

**Repository Path**: btears/api-builder

## Basic Information

- **Project Name**: api-builder
- **Description**: 低代码API生成工具，专注前端开发，让数据不再成为负担！
- **Primary Language**: NodeJS
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 0
- **Created**: 2023-08-02
- **Last Updated**: 2025-05-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: API, 低代码, 前端

## README

# 1、前言

         gitee地址：[api-builder: 低代码API生成工具，专注前端开发，让数据不再成为负担！](https://gitee.com/btears/api-builder.git)

         本项目是一个低代码API接口生成工具，无需使用Mock.js编写代码模拟数据，可直接通过可视化界面创建接口。真实的前后端数据交互，真实的http请求与响应。

        本工具非常适合前后端分离开发的任务场景，无需依赖后端接口，前端开发者可以使用本工具快速生成满足需求的真实接口，专注前端开发，让数据不再成为负担！

        前置知识：了解node、npm相关知识

        系统环境：node v16.20.0+、npm v8.19.4+、git v2.0+

# 2、下载使用

```shell
git clone https://gitee.com/btears/api-builder.git
cd api-builder
npm install
npm run dev
```

项目启动成功后浏览器输入 http://localhost:8888 访问

如果`npm install`安装依赖报错，一般是由于依赖包版本冲突，可以使用`npm install --force`解决

# 3、功能预览

## 3.1、分组管理

        通过分组功能集中管理API，配合多团队、多项目开发。

![输入图片说明](assets/imgs/1693968149640.jpg)

## 3.2、新增接口

        新增接口默认是“GET”请求方式，目前支持的方式有“GET”、“POST”、“DELETE”、“PUT”、“PATCH”。

        响应数据支持三种方式设置，一是通过编辑器手动输入JSON格式数据；二是通过导入按钮选择本地JSON文件导入设置（确保JSON文件格式正确）；三是选择预设数据（目前只有“用户信息”预设数据）。

![新增接口](assets/imgs/2023-08-26-16-25-19-image.png)

## 3.3、接口测试

        工具内提供了接口测试功能，调用接口后会以弹窗的形式显示你设置的响应数据，如果接口处于禁用状态，则会返回接口禁用的相关提示信息。

![工具内测试接口](assets/imgs/2023-08-26-16-24-34-image.png)

        你也可以使用Postman、Apifox等其他接口测试工具测试你创建的接口，地址为 http://127.0.0.1:8888 +API路径。

<img title="" src="assets/imgs/1693039201752.jpg" alt="Postman测试接口" width="657">