PHPackages                             laravel-toolbox/swagger-notes - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. laravel-toolbox/swagger-notes

ActiveLibrary[API Development](/categories/api)

laravel-toolbox/swagger-notes
=============================

PHP Laravel ToolBox工具箱之SwaggerPHP生成注释

v1.0.2(3y ago)32.5k—8.3%Apache-2.0PHPPHP ^7.1||^8.0.2||^8.2

Since Dec 4Pushed 2y ago1 watchersCompare

[ Source](https://github.com/mikeah2011/swagger-notes)[ Packagist](https://packagist.org/packages/laravel-toolbox/swagger-notes)[ Docs](https://github.com/mikeah2011/swagger-notes)[ RSS](/packages/laravel-toolbox-swagger-notes/feed)WikiDiscussions main Synced 3w ago

READMEChangelog (3)Dependencies (3)Versions (5)Used By (0)

### Laravel 開發工具箱之 `SwaggerNotes` 生成工具

[](#laravel-開發工具箱之-swaggernotes-生成工具)

> 註：該工具僅生成注釋內容，依賴 `swagger-php` 包才能生成 `.yaml` 接口文件

1. 本地開發環境安裝依賴包

    ```
    composer require laravel-toolbox/swagger-notes --dev
    ```
2. 請在 `Controller` 類中對應的方法 `return` 前，加入如下代碼：

    ```
    \Toolbox\Facades\SwaggerNotes::setRequest($request)
             ->setResponse($this->jsonRender(TransformHelper::camelSnakeCase($result, 'camel_case')))
             ->setComments(['affilliate_web', 'affilliate', 'member'], $request->rules($this->affiliateService), $this->optionComments)
             ->setApiInfo([
                 'summary' => '查詢大聯盟會員資料',
                 'description' => '含是否填寫個人資料、賬戶資料',
                 'operation_id' => __FUNCTION__,
                 'tags' => __CLASS__,
             ])
             ->generate();
    ```
3. 新增可支持擴展字段的備註信息，在調用類中新增&修改如下代碼即可：

    ```
    public $optionComments = [
         'metadata' => '元數據',
         'data' => '數據',
         'desc' => '狀態描述',
         'infoType' => '資料類型：ALL-全部;PROFILE-個人資料;ADDRINFO-通訊資料;ACCINFO-帳戶資料;WEBINFO-網站資料;',
         'profile' => '個人資料',
         'addrInfo' => '通訊資料',
         'accInfo' => '帳戶資料',
         'webInfo' => '網站資料',
         'brandName' => '白牌名稱',
         'brandSetting' => '白牌設置',
         'imageUrl' => '圖片連結',
         'brandUrl' => '白牌連結',
         'footerCopyright' => '底部授權信息',
         'citys' => '所含城市',
         'prods' => '所含省份',
         'profileFinished' => '個人資料是否完成的標識',
         'accInfoFinished' => '賬戶資料是否完成的標識',
         'isApproved' => '聯盟審核是否通過的標識',
         'isActive' => '聯盟賬戶是否活躍的標識',
     ];
    ```
4. 默認生成路徑在`swagger/SwaggerNotes`目錄下，層級結構如下：

    ```
    swagger
    ├── Swagger                        # 生成的注釋目錄
    │     ├── Affiliate                # 生成的接口目錄
    │     │      └── affiliateView.php # 生成的接口注釋文件
    │     └── swagger.php              # 生成的注釋頭部信息文件
    ├── swagger-constants.php
    ├── swagger-info.php
    ├── swagger.yaml
    └── swagger_doc.yaml               # 生成的接口文件
    ```
5. 附表

    方法釋義可选備註`setRequest`設置請求體，可解析出當前接口的`method`、`parameter`、`url`、`pathInfo`等✔️第二個形參可选，支持被改造的Request請求體，如：`new GetAffiliateParameter($request)``setResponse`設置返回體，可直接給返回的數組結構`setComments`設置字段的備註、規則等✔️接口字段涉及的表集合；驗證規則，不設置則取`->rules()``setApiInfo`設置 API\_INFO 的相關參數summary設置當前接口文檔的`summary`概述信息✔️不設置則取`->name()`description設置當前接口文檔的`description`描述信息✔️operation\_id設置當前接口文檔的操作`ID`標識建議`__FUNCTION__`tags設置當前接口文檔的標籤分類建議`__CLASS__``generate`生成文檔僅本地、測試環境或開啟 debug 模式時生效

###  Health Score

32

—

LowBetter than 69% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity23

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity62

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~34 days

Total

3

Last Release

1228d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/1960620250b8f1627dde331028e6e19ef90637cc50244bb3b60aeeafc7c479ac?d=identicon)[Michael\_Ma](/maintainers/Michael_Ma)

---

Top Contributors

[![mikeah2011](https://avatars.githubusercontent.com/u/31590366?v=4)](https://github.com/mikeah2011 "mikeah2011 (18 commits)")

---

Tags

laravelswaggerToolboxSwagger-PHPnotesswagger-php-notes

### Embed Badge

![Health badge](/badges/laravel-toolbox-swagger-notes/health.svg)

```
[![Health](https://phpackages.com/badges/laravel-toolbox-swagger-notes/health.svg)](https://phpackages.com/packages/laravel-toolbox-swagger-notes)
```

###  Alternatives

[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

2.9k36.4M126](/packages/darkaonline-l5-swagger)[infyomlabs/swagger-generator

Swagger Generator for InfyOm Laravel Generator

1141.1M5](/packages/infyomlabs-swagger-generator)[latrell/swagger

Swagger for Laravel 5

4163.0k](/packages/latrell-swagger)[scalar/laravel

Render your OpenAPI-based API reference

67144.1k3](/packages/scalar-laravel)[adrenalinkin/swagger-resolver-bundle

Provides possibility for validate data according to Swagger documentation

1013.3k](/packages/adrenalinkin-swagger-resolver-bundle)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)