2017 © Pedro Peláez
 

symfony-bundle api-doc-bundle

Generates documentation for your REST API from annotations

image

nelmio/api-doc-bundle

Generates documentation for your REST API from annotations

  • Friday, July 27, 2018
  • by Seldaek
  • Repository
  • 72 Watchers
  • 1491 Stars
  • 10,111,916 Installations
  • PHP
  • 232 Dependents
  • 24 Suggesters
  • 637 Forks
  • 51 Open issues
  • 61 Versions
  • 7 % Grown

The README.md

NelmioApiDocBundle

Build Status Total Downloads Latest Stable
Version, (*1)

The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs., (*2)

Migrate from 3.x to 4.0

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

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., (*4)

Migrate from 2.x to 3.0

To migrate from 2.x to 3.0, follow our guide., (*5)

Installation

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

composer require nelmio/api-doc-bundle

Documentation

Read the documentation on symfony.com, (*7)

Contributing

See CONTRIBUTING file., (*8)

Running the Tests

Install the Composer dependencies:, (*9)

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

Then run the test suite:, (*10)

./phpunit

License

This bundle is released under the MIT license., (*11)

The Versions

23/05 2012

1.0.1

1.0.1.0

Generates documentation for your REST API from annotations

  Sources   Download

MIT

The Requires

 

api rest documentation doc

23/05 2012

1.0.0

1.0.0.0

Generates documentation for your REST API from annotations

  Sources   Download

MIT

The Requires

 

The Development Requires

api rest documentation doc