1 Star 2 Fork 0

WXG / sim-api

Create your Gitee Account
Explore and code with more than 5 million developers,Free private repositories !:)
Sign up
This repository doesn't specify license. Without author's permission, this code is only for learning and cannot be used for other purposes.
Clone or download
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README.md

此版本不再更新,新版本移动至:https://gitee.com/xgpxg/sim-framework/tree/master/sim-api


2019/12/10:1.移除mysql依赖,使用H2数据库,使得完全与业务解耦;2.修复已知bug

2019/11/18:1.新增API类型查询条件:自动注册、手动注册;2.增加API列表应用状态显示;3.修复已知bug

2019/11/16:新增手动注册API功能

2019/11/02:1.优化API注册效率;2.修复已知bug


sim-api

介绍

sim-api是一个极简的后端接口数据模拟框架,是为了解决多个服务或系统之间的数据依赖因为开发进度而相互影响的问题,适用于普通SpringBoot项目及微服务。

特点

  1. 代码侵入性几乎为0,只需要添加几行配置即可使用

  2. 接口信息自动注册、自动同步,无需手动添加接口

  3. 简单的操作方式,模拟数据一键开启或关闭

  4. 支持不同的请求方式返回不同的模拟数据

原理

  1. 通过在应用中引入sim-api-client,扫描controller信息,然后注册到服务端,服务端控制是否开启模拟数据;

  2. 客户端缓存服务端模拟接口和数据,拦截应用请求,如果是模拟接口则直接返回模拟数据;

  3. 服务端定时扫描客户端信息,检查客户端健康状态。

使用框架

SpringBoot

Vue

Hey ui

稳定版

2019/12:sim-api-1.0.0

使用教程

(于2019/12/10移除对mysql依赖,不再依赖mysql)。

服务端
  1. 获取(release分支)到本地编译并构建jar包

构建sim-api-server

cd 源码目录/sim-api-server

mvn clean package
  1. 启动服务端:

    java -jar sim-api-server-0.0.1-SNAPSHOT.jar

  2. 访问web界面:

    http://localhost:5221

  3. 将构建好的sim-api-client引入到您的项目的pom文件中,启动应用即可自动注册API信息到服务端

客户端
  1. 获取(release分支)到本地编译并构建jar包

构建sim-api-client

cd 源码目录/sim-api-client

mvn clean package
  1. 引入maven
    <dependency>
        <groupId>com.yao2san</groupId>
        <artifactId>sim-api-client</artifactId>
        <version>1.0.0</version>
    </dependency>
  1. 在项目的yml配置文件中添加配置:
    sim-api:
      enabled: true
      server:
        addr: 127.0.0.1:5221
  1. 启动项目,日志输出如下内容,表明接口注册成功:

    start scan api

    sim-api : find api [/test/test]

    ......

    find total 5 api

    start register api,server address : http://127.0.0.1:5221/sim-api/register

    sim-api registration success

示例页面

应用列表:

输入图片说明

API列表:

输入图片说明

手动新增API:

输入图片说明

修改模拟数据:

输入图片说明

模拟API

  1. 开启模拟

在API列表页面,切换“数据模拟”开关来开启/关闭模拟API。

  1. 修改模拟数据

在API列表页面,点击“编辑按钮”,修改模拟返回数据。

Comments ( 0 )

Sign in for post a comment

About

一个简易的后端接口模拟框架 spread retract
Java
Cancel

Releases (1)

All

Contributors

All

Activities

load more
can not load any more
Java
1
https://gitee.com/xgpxg/sim-api.git
git@gitee.com:xgpxg/sim-api.git
xgpxg
sim-api
sim-api
master

Search