https://github.com/imiphp/imi-apidoc

imi 框架 HTTP API 文档生成器，支持 Swagger！
https://github.com/imiphp/imi-apidoc

Last synced: about 1 year ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/imiphp/imi-apidoc
• Owner: imiphp
• License: mit
• Created: 2020-05-18T07:56:34.000Z (about 6 years ago)
• Default Branch: 2.0
• Last Pushed: 2023-12-29T07:19:31.000Z (over 2 years ago)
• Last Synced: 2025-04-14T20:41:31.959Z (about 1 year ago)
• Language: PHP
• Homepage:
• Size: 235 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# imi-apidoc

[![Latest Version](https://img.shields.io/packagist/v/imiphp/imi-apidoc.svg)](https://packagist.org/packages/imiphp/imi-apidoc)

[![Php Version](https://img.shields.io/badge/php-%3E=7.4-brightgreen.svg)](https://secure.php.net/)

[![Swoole Version](https://img.shields.io/badge/swoole-%3E=4.7.0-brightgreen.svg)](https://github.com/swoole/swoole-src)

[![IMI License](https://img.shields.io/github/license/imiphp/imi-apidoc.svg)](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安装，遵循psr-4自动加载规则，在你的 `composer.json` 中加入下面的内容:

```json

{

    "require": {

        "imiphp/imi-apidoc": "~2.0.0"

    }

}

```

然后执行 `composer update` 安装。

## 使用说明

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

项目配置文件：

```php

[

    'components'    =>  [

        'ApiDoc'  =>  'Imi\ApiDoc',

    ],

]

```

Swagger 书写文档说明：

**Demo:**

```php



## 免费技术支持

QQ群：17916227 [![点击加群](https://pub.idqqimg.com/wpa/images/group.png "点击加群")](https://jq.qq.com/?_wv=1027&k=5wXf4Zq)，如有问题会有人解答和修复。

## 运行环境

- [PHP](https://php.net/) >= 7.4

- [Composer](https://getcomposer.org/) >= 2.0

- [Swoole](https://www.swoole.com/) >= 4.7.0

## 版权信息

`imi-apidoc` 遵循 MIT 开源协议发布，并提供免费使用。

## 捐赠



开源不求盈利，多少都是心意，生活不易，随缘随缘……