noma-solutions/api-doc-bundle

Enhanced version of NelmioApiDoc that generates documentation for your REST API from annotations

v4.1.0 2020-12-10 22:00 UTC

Requires

• php: >=7.1.3
• ext-json: *
• phpdocumentor/reflection-docblock: ^3.1|^4.4|^5.0
• symfony/framework-bundle: ^4.4|^5.0
• symfony/options-resolver: ^4.4|^5.0
• symfony/property-info: ^4.4|^5.0
• zircote/swagger-php: ^3.0

Requires (Dev)

• api-platform/core: ^2.4
• doctrine/annotations: ^1.11
• doctrine/common: ^2.4
• friendsofsymfony/rest-bundle: ^2.8|^3.0@dev
• jms/serializer: ^1.14|^3.0
• jms/serializer-bundle: ^2.3|^3.0
• sensio/framework-extra-bundle: ^4.4|^5.0
• symfony/asset: ^4.4|^5.0
• symfony/browser-kit: ^4.4|^5.0
• symfony/cache: ^4.4|^5.0
• symfony/config: ^4.4|^5.0
• symfony/console: ^4.4|^5.0
• symfony/dom-crawler: ^4.4|^5.0
• symfony/form: ^4.4|^5.0
• symfony/phpunit-bridge: ^5.2
• symfony/property-access: ^4.4|^5.0
• symfony/routing: ^4.4|^5.0
• symfony/stopwatch: ^4.4|^5.0
• symfony/templating: ^4.4|^5.0
• symfony/twig-bundle: ^4.4|^5.0
• symfony/validator: ^4.4|^5.0
• willdurand/hateoas-bundle: ^1.0|^2.0

Suggests

• api-platform/core: For using an API oriented framework.
• friendsofsymfony/rest-bundle: For using the parameters annotations.

Conflicts

• symfony/framework-bundle: 4.2.7

MIT

• Nelmio
• Symfony Community

• documentation
• rest
• api
• doc

README

About our Fork

Disclaimer: This is fork of nelmio/NelmioApiDocBundle created for our internal use.

First of all we needed to change the mechanism behind model registration so the JMS model hash won't be created based on groups and FQCN but on fields list.

Let's find out if we can manage to do this :)

Introduction

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

Migrate from 2.x to 3.0

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

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

Contributing

See CONTRIBUTING file.

Running the Tests

Install the Composer dependencies:

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

Then run the test suite:

./phpunit

License

This bundle is released under the MIT license.