Thresh

Laravel API 文档生成器,可以将基于 Laravel 项目的项目代码，自动生成 json 或 md 格式的描述文件。

安装

$ composer require telstatic/thresh -vvv

功能

1. 生成 Markdown 文档
2. 生成 Postman 配置文件
3. 生成 Swagger 配置文件

源码

github

使用示例

参数使用 @params 开头，后接 5 位或 7位字符串，分别代表参数名、类型、是否必须、默认值、最小值（可选）、最大值（可选）和 备注。

.
.
.
  /**
     * 测试保存.
     *
     * @desc 测试保存
     *
     * @params title string yes null 标题
     * @params name string yes null 名称
     * @params sort integer yes 0 排序
     * @params is_show integer yes 1 是否显示
     * @params thumb string yes null 封面
     * @params enabled_at string yes null 生效时间
     * @params disabled_at string yes null 失效时间
     *
     */
    public function store(ThreshRequest $request)
    {
    }
.
.
.

截图

本作品采用《CC 协议》，转载必须注明作者和本文链接