Laravel API 文件生成器

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 協議》，轉載必須註明作者和本文連結