dminustin/laravel-api-factory

为 Laravel 框架提供的全功能、灵活且可定制的代码生成器,可节省您的时间。此工具可以帮助您生成控制器、路由、Swagger 文档、Postman 收集等资源。

1.3.0.4 2023-05-07 13:50 UTC

This package is auto-updated.

Last update: 2024-09-07 17:04:40 UTC


README

Latest Stable Version Total Downloads Latest Unstable Version License PHP Version Require

为 Laravel 框架提供的全功能、灵活且可定制的代码生成器,可节省您的时间。此工具可以帮助您生成控制器、路由、Swagger 文档、Postman 收集等资源。

这使得

  • 控制器
  • 操作
  • 路由
  • Swagger 文档
  • Postman 收集
  • 操作单元测试

在我的所有 Laravel 项目中都有一个痛点:有必要创建路由、控制器、验证器等更多的常规操作。从项目到项目,我不得不做同样的操作。
为此,我编写了一个 composer 组件,可以帮助我轻松完成所有任务。我希望我的组件对其他 Laravel 程序员有所帮助。
我很乐意接受任何反馈、评论、建议

总体哲学是

"操作" 包含所有功能,您可能希望在不使用 HTTP 请求的情况下使用它,例如在工作者中

"控制器" 必须调用 "操作" 以执行任何操作,并必须返回操作结果。控制器中不包含逻辑

默认目录/文件结构

config
 | api-factory.php
app
| routes
    | example.yaml
| http
  | ApiFactory
    | Actions
      | ...
    | Controllers
      | ...

路径和文件名可以在 api-factory.php 文件中更改
您可以在 ROUTES 中看到路由指令。
控制器继承自 ApiFactoryController
操作继承自 ApiFactoryAction
您可以在占位符中更改父类

不要忘记在您的 app/Http/Middleware/VerifyCsrfToken.php 文件中添加异常

    //just example
    protected $except = [
        '/api/*'
    ];

待办事项

  • 在路由中实现中间件

安装

您可以通过 composer 安装此包

composer require dminustin/laravel-api-factory

Swagger 文档

composer require --dev DarkaOnLine/L5-Swagger

API 文档将在 /api/documentation 可用

http://127.0.0.1:8000/api/documentation

配置

php artisan vendor:publish --tag=api-factory

更改配置文件 config/api-factory.php

您可以更改 ./stubs 文件

  • api_factory_action
  • api_factory_controller
  • api_factory_router

使用

php artisan api:factory

逐步创建路由

php artisan api:create

测试

composer test

变更日志

请参阅 CHANGELOG 了解最近更改的更多信息。

许可证

MIT 许可证 (MIT)。请参阅 许可证文件 了解更多信息。