madong/swagger
Composer 安装命令：
composer require madong/swagger
包简介
The Madong Swagger component
README 文档
README
简介
这是一个基于 PHP 的 Swagger 注解库，用于在项目中通过注解方式定义 API 文档信息。它提供了一系列属性类和处理器接口，帮助开发者快速生成符合 OpenAPI 规范的接口文档。
主要功能
- 提供多种注解属性用于定义 API 操作、响应格式、请求参数等
- 支持自动生成 JSON 格式的 API 响应示例
- 提供基础处理器接口用于扩展自定义文档处理逻辑
核心组件
ProcessorInterface- 文档处理器接口规范AbstractProcessor- 抽象处理器基类ApiOperation- 定义 API 操作元数据FormRequest- 定义表单请求参数结构ResultResponse及其子类 - 定义不同场景的响应格式Property- 定义数据模型属性
使用示例
// 在控制器方法中使用注解
#[ApiOperation('用户登录')]
#[ReadResponse(User::class)]
public function login()
{
// 你的业务逻辑
}
安装
通过 Composer 安装：
composer require madong/swagger
贡献指南
欢迎贡献代码和改进文档。请先 fork 项目，创建新分支进行开发，最后提交 Pull Request。
统计信息
- 总下载量： 0
- 月度下载量： 0
- 日度下载量： 0
- 收藏数： 0
- 点击次数： 0
- 依赖项目数： 0
- 推荐数： 0
其他信息
- 授权协议： Apache-2.0
- 更新时间： 2025-11-13