包简介

Generates documentation for your REST API from attributes

README 文档

README

The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.

Installation

Open a command console, enter your project directory and execute the following command to download the latest version of this bundle:

composer require nelmio/api-doc-bundle

Documentation

Read the documentation on symfony.com

Migrate from 4.x to 5.0

To migrate from 4.x to 5.0, follow our guide.

This version comes with the following major changes:

The bundle now requires PHP 8.1 or higher.
Support for annotations has been removed in favor of PHP 8 attributes.
Minimum Symfony version is now 6.4.
Major cleanup and simplification of the codebase.

Migrate from 3.x to 4.0

To migrate from 3.x to 4.0, follow our guide.

Version 4.0 brings OpenAPI 3.0 support. If you want to stick to Swagger 2.0, you should use the version 3 of this bundle.

Migrate from 2.x to 3.0

To migrate from 2.x to 3.0, follow our guide.

Contributing

See CONTRIBUTING file.

Running the Tests

Install the Composer dependencies:

git clone https://github.com/nelmio/NelmioApiDocBundle.git
cd NelmioApiDocBundle
composer update

Then run the test suite:

composer phpunit

License

This bundle is released under the MIT license.

nelmio/api-doc-bundle 适用场景与选型建议

nelmio/api-doc-bundle 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 66.65M 次下载、GitHub Stars 达 2.35k，最近一次更新时间为 2012 年 04 月 13 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「documentation」「rest」「api」「doc」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 nelmio/api-doc-bundle 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 nelmio/api-doc-bundle 我们能提供哪些服务？

定制开发 / 二次开发

基于 nelmio/api-doc-bundle 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 nelmio/api-doc-bundle 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

bookdown/themes 11

Bookdown.io With Bootswatch Styles And Prism Syntax Highlighting

code-orange/jot 7

Laravel package that generates RESTful API documentation in Markdown based on PHPDoc.

theodorejb/phaster 6

A PSR-7 compatible library for making CRUD API endpoints

braune-digital/api-base-bundle 0

Api bundle

johnylemon/laravel-apidocs 46

Laravel API documentation generating tool

intahwebz/flickrguzzle 4

A Flickr wrapper to allow you to call the Flickr api with Guzzle as the backend.Goal is to have 100% Flickr api coverage rather than just upload/display photos (currently at 23%).

nelmio/api-doc-bundle

包简介

关键字：