zxxi7i/mock

根据注解自动生成 生成路由 + 生成接口文档 + Mock测试数据

v1.0.4 2024-05-25 02:10 UTC

Requires

• doctrine/annotations: ^1.6
• fzaninotto/faker: ^1.9
• php-di/phpdoc-reader: ^2.1
• symfony/class-loader: ~3.2.0
• topthink/think-view: ^1.0

Apache-2.0

• zsw

• mock
• doc
• annotation

README

测试

请求方式：post

请求参数：{username:"zsw"}

接口地址：http://demo.mi.zsw.ink/show

Mock地址：http://demo.mi.zsw.ink/show?m=1

地址

邮件 zswemail@qqcom

主页 https://zsw.ink 查看手册，留言

gitee https://gitee.com/zxxi7i/mock

使用

1. 安装

composer require zxxi7i/mock

1. 添加测试代码 在 app/controller 目录下增加Test.php文件

<?php
namespace app\controller;

use app\BaseController;
use mock\annotation\illustrate\AutoValidate;
use mock\annotation\illustrate\Route;
use mock\annotation\illustrate\Mock;
use mock\annotation\illustrate\MockPack;
use mock\annotation\illustrate\WikiItem;
use mock\annotation\illustrate\WikiMenu;

/**
 * @WikiMenu("测试")
 * @package app\controller
 * Author: zsw [e-mail]
 */
class Test extends BaseController
{

    /**
     * @Route("test", method="GET")
     * @WikiItem("首页", description="首页详情")
     *
     * @AutoValidate({"username":"require|chsAlpha"}, message={"username":"请输入用户名"})
     * @Mock("username", mode="request", title="用户名", example="name")
     * @Mock("name", mode="response", title="名字", example="name", description="文章ID")
     */
    public function index($username){
        return "hello " . $username;
    }

    /**
     * @Route("mock", method="GET")
     * @WikiItem("详情", description="文章详情")
     *
     * @Mock("id", title="ID", example="numberBetween", description="文章ID")
     * @MockPack("articles", mode="response", title="文章列表", description="文章列表", limit=5)
     * @Mock("id", mode="response", title="ID", example="randomDigitNotNull", description="文章ID")
     * @Mock("title", mode="response", title="标题", example="name")
     * @Mock("create_time", mode="response", title="创建时间", example={"date": {"Y-m-d", "now"}})
     * @Mock("content", mode="response", title="内容", example={"sentence": 10})
     * @Mock("image", mode="response", title="图片", example="randomDigit")
     * @MockPack("user", main=true, mode="response", title="用户", description="发布者信息", limit=0)
     * @Mock("username", mode="response", title="用户名", example="name")
     * @MockPack("user")
     * @MockPack("articles")
     * @Mock("page", mode="response", title="页码", example="randomDigitNotNull", description="当前页码")
     */
    public function mock(){}
}

1. 访问路由、测试数据、接口文档

路由：/test?username=zsw

数据：/mock?mock=1

文档：/wiki

功能说明

1. 注解路由

路由注解 模型注解 自动注入同Tp6官方注解

// 新增AutoValidate注解
@AutoValidate({"username":"require|chsAlpha"}, message={"username":"请输入用户名"})

1. Mock 测试数据生成

Mock 用法

// example可以自定义数据也可以使用生成器Mock测试数据 传入方法名即可 数据生成参考 https://github.com/fzaninotto/Faker

@Mock("title", mode="response", title="标题", example="name")

MockPack 嵌套数据生成 类属于多层数组 支持无限级嵌套

@MockPack extends MockBase
    // 数据长度 0表示单层数据
    @var int limit 
    
    /*
     * 置顶 （limit > 1 时有效)
     * false：['fields'=>[["a"=>"b"], ["aa"=>"bb"]]]
     * true：[["a"=>"b"], ["aa"=>"bb"]]
     */
    @var boolean main

// 举个例子：
// MockPack(key)  MockPack中key相同值之间组成一层嵌套

/**
 * @MockPack("articles", mode="response", title="文章列表", description="文章列表", limit=3)
 *
 * @Mock("title", mode="response", title="标题", example="name")
 * @Mock("content", mode="response", title="内容", example={"sentence": 10})
 *
 * @MockPack("user", main=true, mode="response", title="用户", description="发布者信息", limit=0)
 * @Mock("username", mode="response", title="用户名", example="name")
 * @MockPack("user")
 * 
 * @MockPack("articles")
 */
 
//生成结果
{
	"articles": [{
		"title": "乔阳",
		"content": "Vero impedit et consequatur quasi doloribus dolores illum sit expedita doloremque fugiat esse deleniti quisquam.",
		"user": {
			"username": "方建明"
		}
	}, {
		"title": "蒙桂花",
		"content": "Iure explicabo officiis minima et impedit sunt dignissimos necessitatibus ratione animi nam aperiam dolorum.",
		"user": {
			"username": "谷致远"
		}
	}, {
		"title": "郑文",
		"content": "Minus cum unde exercitationem sunt laudantium eveniet voluptatem magni ut cum non.",
		"user": {
			"username": "宁丽娟"
		}
	}]
}

1. 接口文档生成

// @WikiMenu 分类名
// @WikiItem 菜单

<?php
/**
 * @WikiMenu("测试")
 */
class Test extends BaseController
{
    /**
     * @Route("test", method="GET")
     * @WikiItem("首页", description="首页详情")
     * @Mock("name", mode="response", title="名字", example="name", description="名字")
     */
    public function index(){
        return "zsw";
    }
}

示例

1. composer引入

2. 请在app\controller 目录下 添加测试文件 Test.php

<?php
namespace app\controller;

use app\BaseController;
use mock\annotation\illustrate\Route;
use mock\annotation\illustrate\Mock;
use mock\annotation\illustrate\MockPack;
use mock\annotation\illustrate\WikiItem;
use mock\annotation\illustrate\WikiMenu;

/**
 * @WikiMenu("测试")
 */
class Test extends BaseController
{
    /**
     * @Route("mock", method="GET")
     * @WikiItem("详情", description="文章详情")
     * @Mock("id", title="ID", example="numberBetween", description="文章ID")
     * 
     * @MockPack("articles", mode="response", title="文章列表", description="文章列表", limit=3)
     * @Mock("title", mode="response", title="标题", example="name")
     * @Mock("content", mode="response", title="内容", example={"sentence": 10})
     *
     * @MockPack("user", main=true, mode="response", title="用户", description="发布者信息", limit=0)
     * @Mock("username", mode="response", title="用户名", example="name")
     * @MockPack("user")
     * 
     * @MockPack("articles")
     */
    public function mock(){}
}

1. 访问地址 /mock?mock=1

// 生成的数据格式为
{
	"articles": [{
		"title": "乔阳",
		"content": "Vero impedit et consequatur quasi doloribus dolores illum sit expedita doloremque fugiat esse deleniti quisquam.",
		"user": {
			"username": "方建明"
		}
	}, {
		"title": "蒙桂花",
		"content": "Iure explicabo officiis minima et impedit sunt dignissimos necessitatibus ratione animi nam aperiam dolorum.",
		"user": {
			"username": "谷致远"
		}
	}, {
		"title": "郑文",
		"content": "Minus cum unde exercitationem sunt laudantium eveniet voluptatem magni ut cum non.",
		"user": {
			"username": "宁丽娟"
		}
	}]
}

1. 接口文档生成

<?php
namespace app\controller;

use mock\annotation\illustrate\Route;
use mock\annotation\illustrate\WikiItem;
use mock\annotation\illustrate\WikiMenu;

/**
 * @WikiMenu("测试")
 */
class Test
{

    /**
     * @Route("test", method="GET")
     * @WikiItem("首页", description="首页详情")
     * @Mock("username", mode="request", title="用户名", example="name")
     * @Mock("name", mode="response", title="名字", example={"\app\controller\Mock::name": {100}}, description="文章ID")
     */
    public function index($username){}
}