# http-faker

**Repository Path**: guojongg/http-faker

## Basic Information

- **Project Name**: http-faker
- **Description**: 反向代理+mock server；让mock数据与真实数据兼得。
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/guojongg/http-faker
- **GVP Project**: No

## Statistics

- **Stars**: 41
- **Forks**: 6
- **Created**: 2020-10-30
- **Last Updated**: 2024-11-20

## Categories & Tags

**Categories**: api-gateway

**Tags**: None

## README

# http-faker

#### 介绍
**灵活又简单的mock服务**

[![star](https://gitee.com/guojongg/http-faker/badge/star.svg?theme=dark)](https://gitee.com/guojongg/http-faker/stargazers)
[![Downloads](https://pepy.tech/badge/httpfaker)](https://pepy.tech/project/httpfaker)
[![pypi version](https://img.shields.io/pypi/v/httpfaker.svg)](https://pypi.python.org/pypi/httpfaker)

gitee地址： https://gitee.com/guojongg/http-faker

httpfaker基于faker和flask库，提供强大的逻辑处理能力；通过对配置文件（yaml/json）的描述，可返回想要的任意数据。

支持反向代理模式，只需要设置一个目标服务器地址，即可变成一个反向代理服务器；当匹配到mock规则时返回mock数据；未命中时做代理请求并返回请求结果。

httpfaker针对返回数据的规则编写灵活，简单。除了可以满足传统的接口mock外，还支持处理业务逻辑，可实现真正的业务功能。


适用于：
* 前端人员： 前后端分离开发，无需等到后台接口实现即可开始进行页面请求
* 测试人员： 提前进行接口测试代码编写；**服务未至，用例先行**
* 其他需要写一个简单api的人员： 通过yaml文件配置，可减少开发代码；无需关注请求处理部分，只需关注自己的业务逻辑即可。

#### 简单使用
```shell script
# 安装
pip install httpfaker

# 简单使用
httpfaker init
cd httpfaker-project
httpfaker --proxy http://example.com # 指定代理地址时，将作为代理服务器对未命中的请求自动转发到指定的服务器中
```
![img003](https://gitee.com/guojongg/http-faker/raw/master/docs/image/img003.gif)


上面例子中使用`httpfaker init`预生成了一个 [example.yml](https://gitee.com/guojongg/http-faker/blob/master/apis/api_login_POST.yml) 文件，yaml文件中描述了一个登录的场景：
1. 前端通过`post`方法调用`/api/login`这个地址，并在请求body中传来了`username`和`password`两个参数。
2. `httpfaker`接收到请求后会按照logic中描述的逻辑进行业务处理：先打印了请求参数，再调用`verify_accont`方法，
来验证用户名和密码是否匹配；然后调用`gen_token`方法，生成`token`。
*（verify_account和gen_token方法已经注册到httpfaker调用函数中了，注册方法见[自定义方法的注册](docs/自定义方法使用说明.md)）*

3. 在逻辑处理完成后，httpfaker按照`response`中描述的内容进行字段返回，`headers`中引用了在`env`中定义的
`content_type`; `body`中的`code、msg、data`等字段直接引用logic中已经生成的结果。

在上述流程中完成了用户登录到返回数据的一个完整流程，包含了业务处理部分，使mock服务不仅仅只是mock，还可以包括真实的业务逻辑。

#### 配套工具
* [**http2api**](https://gitee.com/guojongg/http-faker/blob/master/docs/http2api使用说明.md): httpfaker支持录入接口数据，使用http2api，只需要在前端进行请求，可以自动将请求内容转换为httpfaker可读的模板。
* [**swagger2api**](https://gitee.com/guojongg/http-faker/blob/master/docs/swagger2api使用说明.md): 支持将swagger格式的接口数据直接转换为httpfaker可读的模板。

#### 其它
[使用httpfaker实现文件上传下载](https://gitee.com/guojongg/http-faker/blob/master/docs/httpfaker使用举例1.md)

[yaml文件编辑说明](https://gitee.com/guojongg/http-faker/blob/master/apis/api_login_POST.yml)

[同时使用代理与mock说明](https://testerhome.com/topics/27180)