hyperf 实战之 swagger 文档

今天我们一起看下 hyperf 框架内是怎么使用 swagger 文档的。

市面上可选择的接口文档很多，像 ShowDoc、Postman、Apipost、eolink 等等，有些是支持本地化部署的，有些是云上操作的，大家可以自己去选择。

今天我们要介绍的是可以在线生成的、可视化的 api 文档 swagger，swagger 官网参考 https://swagger.io/。

hyperf 官方在 3.0.* 也对 swagger 做了支持，参考 hyperf/swagger 组件（https://github.com/hyperf/swagger） ，其本质还是 zircote/swagger-php （https://github.com/zircote/swagger-php），文档的生成主要依赖注释。

先看效果图：

下面演示下如何在 hyperf 框架内使用 swagger 文档。

1、安装 hyperf/swagger 组件

composer require hyperf/swagger:3.0.0

2、全局配置