wp-breeder/swoft-swagger
Composer 安装命令：
composer require wp-breeder/swoft-swagger
包简介
swagger component for swoft
README 文档
README
说明
swoft 的 swagger 组件， 本组件依赖swagger-php 3.0及以上版本, 需使用 openapi 规范编写接口文档
安装
- composer command
composer require wp-breeder/swoft-swagger:dev-master
swoft-1.x 请查看 1.0.0 版本文档
AUTO_SWAGGER用来控制该组件是否启用
# 在 .env 中添加 auto swagger 开启swagger组件
AUTO_SWAGGER=true
用法
- 发布
Swagger UI的静态资源到项目的public目录
注意：因为在实际开发中可能会有多个 swoft 服务，所以推荐单独部署 swagger ui, 通过修改 json 地址的方式渲染接口文档
php bin/swoft swagger:publish swoft/swagger
openapi json地址:http://{ip}:{host}/__swagger/api-json, 该接口会动态生成最新接口json, 方便Swagger UI渲染接口文档
注意：本项目会占用 /__swagger/api-json 和 /__swagger/docs 两个路由
- 在项目的除了
/project/to/path/vendor,/project/to/path/test,/project/to/path/tests的任何地方开始编写接口文档，即可生成openapi json, 如需在本项目访问接口文档(已发布静态资源), 则访问http://{ip}:{host}/__swagger/docs
更多关于 openapi 的文档或示例
- https://www.openapis.org/
- https://swagger.io/docs/
- https://github.com/zircote/swagger-php/tree/master/Examples
LICENSE
The Component is open-sourced software licensed under the Apache license.
wp-breeder/swoft-swagger 适用场景与选型建议
wp-breeder/swoft-swagger 是一款 基于 PHP 开发的 Composer 扩展包，目前已累计 144 次下载、GitHub Stars 达 4， 最近一次更新时间为 2018 年 11 月 27 日， 在 PHP 生态内属于活跃度较高的组件。
它主要适用于以下技术方向： 「php」 「swagger」 「swoole」 「api doc」 「swoft」 等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。
我们在过去多个企业项目中使用过 wp-breeder/swoft-swagger 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。
基于 wp-breeder/swoft-swagger 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。
与 wp-breeder/swoft-swagger 相关的其它包
同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：
Swagger integration to Laravel 5
Easy Swagger endpoint using the Zend Expressive routes config
一个接口文档生成器
annotations-scan-plugin
OpenAPI specification generator and Swagger UI for PHP 7.2-8.4 projects (standalone and Nette Framework)
统计信息
- 总下载量： 144
- 月度下载量： 0
- 日度下载量： 0
- 收藏数： 4
- 点击次数： 2
- 依赖项目数： 0
- 推荐数： 0
其他信息
- 授权协议： Apache-2.0
- 更新时间： 2018-11-27