ZOYKU火線榜

nelmio/nelmioapidocbundle技術文件

Generates documentation for your REST API from attributes

多語言回退提示:當前倉庫原作者暫未發布在地化文件,已為您無縫切換至官方英文原版(English),排版及程式碼實例完整保真。
極速安裝
git clone https://github.com/nelmio/nelmioapidocbundle.git

NelmioApiDocBundle

Build Status Codecov Total Downloads Latest Stable Version PHP Version License

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.

FrankenPHP worker mode

The bundle also runs under FrankenPHP worker mode and other long-running workers, see FrankenPHP and long-running workers.

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

Sponsored by

JetBrains logo

JetBrains sponsors this project by providing an open-source license for their tools.

License

This bundle is released under the MIT license.

文件鏡像歸檔自 GitHub 官方源路徑 · 造訪原專案 GitHub
最後同步快照:2026-11-16