PHPackages                             lujihong/hyperf-swagger - 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. lujihong/hyperf-swagger

ActiveLibrary[API Development](/categories/api)

lujihong/hyperf-swagger
=======================

A swagger library for Hyperf.

2.2.0(4y ago)0330MITPHPPHP >=7.3

Since Aug 4Pushed 4y ago1 watchersCompare

[ Source](https://github.com/lujihong/hyperf-swagger)[ Packagist](https://packagist.org/packages/lujihong/hyperf-swagger)[ RSS](/packages/lujihong-hyperf-swagger/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (8)Versions (4)Used By (0)

基于 composer daodao97/apidog 修改优化更好的适配后台前端使用
-------------------------------------------

[](#基于-composer-daodao97apidog-修改优化更好的适配后台前端使用)

Api 生成
------

[](#api-生成)

一个 [Hyperf](https://github.com/hyperf/hyperf) 框架的 Api 参数校验及 swagger 文档生成组件

1. 根据注解自动进行Api参数的校验, 业务代码更纯粹.
2. 根据注解自动生成Swagger文档, 让接口文档维护更省心.
3. 基于daodao97/apidog组件修改，新增RequestApi，注解自定义规则，修改返回的验证结果message换行符修改未增加对应的字段名

> 在 1.2 版本后, 本扩展移除了内部自定义的验证器, 只保留的 hyperf 原生验证器, 以保持验证规则的统一

安装
--

[](#安装)

```
composer require lujihong/hyperf-swagger

```

使用
--

[](#使用)

#### 1. 发布配置文件

[](#1-发布配置文件)

```
php bin/hyperf.php vendor:publish lujihong/hyperf-swagger

# hyperf/validation 的依赖发布

php bin/hyperf.php vendor:publish hyperf/translation

php bin/hyperf.php vendor:publish hyperf/validation
```

### 2. 修改配置文件

[](#2-修改配置文件)

> 注意 与1.2及之前的版本相比, 配置文件结构及文件名 略有不同
>
> (1) 配置文件结构的优化, 增加了swagger外的整体配置
>
> (2) 配置文件的名称 由 swagger.php 改为 apidoc.php

根据需求修改 `config/autoload/apidoc.php`

```