PHPackages                             imiphp/imi-apidoc - 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. imiphp/imi-apidoc

ActiveLibrary

imiphp/imi-apidoc
=================

imi 框架 HTTP API 文档生成器，支持 Swagger！

v2.1.11(2y ago)51101MulanPSL-2.0PHP

Since May 18Pushed 2y ago1 watchersCompare

[ Source](https://github.com/imiphp/imi-apidoc)[ Packagist](https://packagist.org/packages/imiphp/imi-apidoc)[ RSS](/packages/imiphp-imi-apidoc/feed)WikiDiscussions 2.0 Synced 1mo ago

READMEChangelog (10)Dependencies (4)Versions (31)Used By (0)

imi-apidoc
==========

[](#imi-apidoc)

[![Latest Version](https://camo.githubusercontent.com/5d21f85e80c8112f74208bb727592b11c35d3a0df0edf96eee3e6ba78f68f184/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f696d697068702f696d692d617069646f632e737667)](https://packagist.org/packages/imiphp/imi-apidoc)[![Php Version](https://camo.githubusercontent.com/4a5c2ab20974058a8bab53ecb30ac4c2e6bb961df6229b7386fdc097ab53dfa8/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d2533453d372e342d627269676874677265656e2e737667)](https://secure.php.net/)[![Swoole Version](https://camo.githubusercontent.com/f4210afc3f396a720a75802010218d847f3ba4f7ae5182c570b1fb2504ec9ec3/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f73776f6f6c652d2533453d342e372e302d627269676874677265656e2e737667)](https://github.com/swoole/swoole-src)[![IMI License](https://camo.githubusercontent.com/14cd3a31d0faf39e7b2a69afe00560218463ec6885097624b9a2be17398ab44e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f696d697068702f696d692d617069646f632e737667)](https://github.com/imiphp/imi-apidoc/blob/master/LICENSE)

介绍
--

[](#介绍)

支持在项目中使用 Swagger 注解语法，运行命令，生成 Swagger 文件。

Swagger 是最流行的 API 开发工具，它遵循 OpenAPI Specification（OpenAPI 规范，也简称 OAS）。

Swagger 可以贯穿于整个 API 生态，如 API 的设计、编写 API 文档、测试和部署。

Swagger 是一种通用的，和编程语言无关的 API 描述规范。

imi-apidoc 基于 [zircote/swagger-php](https://github.com/zircote/swagger-php) 开发，100% 支持写法。

> 本仓库仅用于浏览，不接受 issue 和 Pull Requests，请前往：

Composer
--------

[](#composer)

本项目可以使用composer安装，遵循psr-4自动加载规则，在你的 `composer.json` 中加入下面的内容:

```
{
    "require": {
        "imiphp/imi-apidoc": "~2.0.0"
    }
}
```

然后执行 `composer update` 安装。

使用说明
----

[](#使用说明)

> 可以参考 `example`、`tests` 目录示例。

项目配置文件：

```
[
    'components'    =>  [
        'ApiDoc'  =>  'Imi\ApiDoc',
    ],
]
```

Swagger 书写文档说明：

**Demo:**

```