kamicloud/stub-api

此包已被弃用且不再维护。未建议替代包。

API 生成器

安装: 289

依赖项: 0

建议者: 0

安全: 0

星标: 8

关注者: 4

分支: 1

开放问题: 1

语言:Java

v1.1.6 2020-11-15 12:13 UTC

README

简介

Stub Api 是一个用于 Laravel 项目的 API 工具包,包括参数验证、版本控制、文档生成和回归测试。

依赖

JDK 8-12

Laravel 5.5 - 6.0

入门

接口部分使用说明 https://learnku.com/articles/25288

注解和对应生成代码详解 https://learnku.com/articles/26733

DEMO https://github.com/Kamicloud/GeneratorDemoProject

安装

composer require kamicloud/stub-api

执行 php artisan stub-api:install 将配置、模板及脚本自动配置在项目目录

执行 bin 目录引入的 initGenerator,

修改 Laravel 项目的一些代码的基类为 generator 基类

目录结构

resources/generator 目录下为模板目录,包含以下子目录

templates 模板目录,包含 TemplateList.java Template*.java Errors.java 等

definitions 注解及定义目录,包含所有的注解及标量数据类型

config 工具配置目录,包含各个功能模块代码输出目录等配置

testcases 测试用例,执行生成会自动填充本目录

使用方式

修改 Template.java 为所需要的格式,执行 generate

修改及添加测试用例,执行 autoTest

机制

initGenerator 时引入 gradle,加载依赖并编译 generator

每次 generate 时,编译模板,替代原编译代码并执行 generator