jeanisahakyan/motion-dots

1.11 2024-02-20 21:53 UTC

README

Typescript模式生成

约定

如果您打算使用typescript api模式生成,您必须遵循以下原则

  • 响应类名称必须是唯一的
  • 在参数和响应类中使用的枚举名称必须是唯一的

结构

api-schema
├── methods
├── enums
└── responses

生成

在项目目录中运行以下内容的php脚本

$schema = Schema::create()
  ->addMethods($methods);
$processor = new Processor($schema, '.');

$files_folder = "./static/api-schema/"; // any existing folder relative to current working directory

Generator::create()
  ->excludeSpaces('accounts', 'users') // default is 'system'
  ->setIsVerbose(false) // default is true
  ->setFilesPath('./static/api-schema') // default is './api-schema'
  ->generate($processor);