蜡虫/waxwink/docgen

用于动态生成API文档的Laravel包

维护者

详细信息

github.com/waxwink/docgen

源代码

问题

安装: 46

依赖者: 0

建议者: 0

安全性: 0

星标: 1

关注者: 1

分支: 0

开放性问题: 0

语言:JavaScript

dev-master 2020-01-02 05:57 UTC

Requires

MIT 7536352182888b1d41528a948ae4c921e60fa814

  • Mohamadreza <mpishdad89.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-29 05:35:52 UTC

README

如果您需要为前端团队快速生成最小化的API文档，这个包可能对您有帮助。

说明

安装时只需使用以下命令

composer require waxwink/docgen

之后，将必要的js和css文件发布到public文件夹以供文档查看

php artisan vendor:publish --tag=public

现在这个包可以通过访问/routes URL来工作，但为了生成更完整的API文档，您需要在Laravel应用程序中遵循一些规则

请求体

为了将每个路由的请求体包含到文档中，您必须在相关的控制器中使用FormRequest对象作为输入参数。DocGen将使用该请求对象来解析请求体，并将规则显示得与请求对象的rules方法中写的一样。

输出键

为了将一个路由的输出键包含在内，每个路由都应该使用JsonResource来显示输出。DocGen必须知道这个资源，并将其作为doc块（带有@DG-Resource）放在控制器方法中，如下所示

    /**
     * @DG-Resource App\Http\Resources\OrderResource
     *
     * @param OrderRequest $request
     * @return AnonymousResourceCollection
     */
    public function index(OrderRequest $request)
    {
        //....
    }