包简介

A Laravel package that uses PHP attributes to document routes, generate readable route listings, and export OpenAPI or Postman definitions.

README 文档

README

A Laravel package that uses PHP attributes to document routes, generate readable route listings, and export OpenAPI or Postman definitions.

Features

Document routes directly using PHP attributes
Validate route documentation in your CI/CD pipeline
Includes CLI tooling for discovery and inspection

TODO:

Add request parameters
Add response schemas
Export route definitions as JSON, OpenAPI, or Postman collections

Installation

composer require mikegarde/laravel-route-docs --dev

Usage

Annotate your controller methods using custom attributes to describe your API:

use RouteDocs\Attributes\get;

class ItemController
{
    #[get('/items', name: 'items.index')]
    public function index()
    {
        return Item::all();
    }
}

Then run:

php artisan route:docs

You’ll get a structured view of your documented routes.

Validate Route Attributes in CI/CD

You can validate that all routes have correct and complete attribute annotations:

php artisan route:docs:validate

This will return non-zero exit codes on failure, making it CI-friendly.

mikegarde/laravel-route-docs 适用场景与选型建议

mikegarde/laravel-route-docs 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 2k 次下载、GitHub Stars 达 0，最近一次更新时间为 2025 年 06 月 09 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「api docs」「cli」「annotation」「routes」「attribute」「laravel」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 mikegarde/laravel-route-docs 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 mikegarde/laravel-route-docs 我们能提供哪些服务？

定制开发 / 二次开发

基于 mikegarde/laravel-route-docs 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发