PHPackages                             wp-breeder/swoft-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. wp-breeder/swoft-swagger

ActiveLibrary[API Development](/categories/api)

wp-breeder/swoft-swagger
========================

swagger component for swoft

v1.0.0(6y ago)4136Apache-2.0PHPPHP >=7.0

Since Jun 10Pushed 6y ago1 watchersCompare

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

READMEChangelog (1)Dependencies (6)Versions (3)Used By (0)

swoft-swagger
-------------

[](#swoft-swagger)

### 说明

[](#说明)

`swoft` 的 `swagger` 组件， 本组件依赖[swagger-php](https://github.com/zircote/swagger-php) 3.0及以上版本, 需使用 `openapi` 规范编写接口文档

### 安装

[](#安装)

1. composer command

```
   composer require wp-breeder/swoft-swagger:dev-master
```

> swoft-1.x 请查看 [1.0.0](https://github.com/wp-breeder/swoft-swagger/tree/1.x) 版本文档

2. `AUTO_SWAGGER` 用来控制该组件是否启用

```
    # 在 .env 中添加 auto swagger 开启swagger组件
    AUTO_SWAGGER=true
```

### 用法

[](#用法)

1. 发布 `Swagger UI` 的静态资源到项目的 `public` 目录

> 注意：因为在实际开发中可能会有多个 swoft 服务，所以推荐单独部署 swagger ui, 通过修改 json 地址的方式渲染接口文档

```
php bin/swoft swagger:publish swoft/swagger
```

2. `openapi json` 地址: `http://{ip}:{host}/__swagger/api-json`, 该接口会动态生成最新接口 `json`, 方便 `Swagger UI` 渲染接口文档

> 注意：本项目会占用 /\_\_swagger/api-json 和 /\_\_swagger/docs 两个路由

3. 在项目的除了`/project/to/path/vendor`,`/project/to/path/test`,`/project/to/path/tests`的任何地方开始编写接口文档，即可生成 `openapi json`, 如需在本项目访问接口文档(已发布静态资源), 则访问 `http://{ip}:{host}/__swagger/docs`

### 更多关于 `openapi` 的文档或示例

[](#更多关于-openapi-的文档或示例)

-
-
-

### LICENSE

[](#license)

The Component is open-sourced software licensed under the [Apache license](https://github.com/wp-breeder/swoft-swagger/blob/master/LICENSE).

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity14

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

2525d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/2671d82051a2f1ec1dc5620f33798b83eb33f101ac26043d337210d8eb726cfc?d=identicon)[wp-Breeder](/maintainers/wp-Breeder)

---

Top Contributors

[![wp-breeder](https://avatars.githubusercontent.com/u/18710927?v=4)](https://github.com/wp-breeder "wp-breeder (1 commits)")

---

Tags

api-docphpswaggerswoftphpswaggerswooleswoftapi-doc

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/wp-breeder-swoft-swagger/health.svg)

```
[![Health](https://phpackages.com/badges/wp-breeder-swoft-swagger/health.svg)](https://phpackages.com/packages/wp-breeder-swoft-swagger)
```

###  Alternatives

[swoft/swoft

Modern High performance AOP and Coroutine PHP Framework

5.6k34.4k](/packages/swoft-swoft)[hyperf/swagger

A swagger library for Hyperf.

19338.7k6](/packages/hyperf-swagger)[daodao97/apidog

A swagger library for Hyperf.

15040.1k1](/packages/daodao97-apidog)[tangwei/apidocs

A swagger library for Hyperf.

51130.4k8](/packages/tangwei-apidocs)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)