RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-04-01 21:06:15 +03:00
Code Issues Projects Releases Wiki Activity
Generates documentation for your REST API from annotations
380 commits 9 branches 28 tags 17 MiB
Find a file
Guilhem N 0bca7f377d
Merge pull request #1447 from AyrtonRicardo/master 
Change validation to allow fields described as DateTimeInterface.
2019-01-02 23:20:13 +01:00
Annotation Added support for @Security annotations (#1201) 2018-01-25 21:11:34 +01:00
Controller Add areas support (#1169) 2018-01-05 13:08:02 +01:00
DependencyInjection Merge pull request #1404 from bifidokk/area-docs 2018-10-06 14:44:53 +02:00
Describer Add ability to use response objects which defined in configuration 2018-10-02 17:02:17 +07:00
Form/Extension Add a documentation form extension (#1234) 2018-02-19 10:56:51 +01:00
Model Fix alternative names issue 2018-11-04 12:24:45 +01:00
ModelDescriber Merge pull request #1447 from AyrtonRicardo/master 2019-01-02 23:20:13 +01:00
Resources faq.rst: enhance readability in symfony.com docs (#1420) 2018-10-31 16:34:46 +01:00
RouteDescriber Respect the spec in the FosRestDescriber (#1390) 2018-08-30 00:41:53 +02:00
Routing Remove documentation from route builder 2018-10-05 15:14:36 +05:00
SwaggerPhp Support `@Model` in in-object annotations 2018-03-22 19:14:01 +01:00
Tests Merge pull request #1447 from AyrtonRicardo/master 2019-01-02 23:20:13 +01:00
Util Apply fixes from StyleCI 2017-12-22 17:42:18 +00:00
.gitignore Fix the tests 2017-03-15 13:38:23 +01:00
.php_cs.dist Allow implicit operations with SwaggerPhp annotations 2017-01-08 12:12:43 +01:00
.styleci.yml Add areas support (#1169) 2018-01-05 13:08:02 +01:00
.travis.yml Run CI pipeline with PHP 7.2 2018-05-28 12:51:45 +02:00
ApiDocGenerator.php Implement alternative naming system via configuration (#1312) 2018-06-10 09:56:38 +02:00
CHANGELOG.md Customizable template and remove Google Fonts (#1357) 2018-07-16 09:45:18 +02:00
composer.json [JMSModelDescriber] Allow to use free form objects from JMS serialization (#1368) 2018-08-21 17:41:32 +02:00
CONTRIBUTING.md Document the bundle 2017-05-13 17:21:28 +02:00
LICENSE Change the vendor to "Nelmio" 2016-12-29 12:09:26 +01:00
NelmioApiDocBundle.php Add areas support (#1169) 2018-01-05 13:08:02 +01:00
phpunit Update PHPUnit to 6.5 and allow newer version of PHPUnit Bridge 2018-05-28 13:58:42 +02:00
phpunit.xml.dist Update travis config (#1117) 2017-11-27 14:40:22 +01:00
README.md Fixes 2018-01-04 17:47:47 +01:00
update-js.sh Include map files 2017-06-22 21:22:10 +02:00
UPGRADE-3.0.md Merge pull request #1264 from adeelnawaz/master 2018-03-24 09:34:31 +01:00

README.md

NelmioApiDocBundle

Build Status Total Downloads Latest Stable Version

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, just 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
composer update

Then run the test suite:

./phpunit

License

This bundle is released under the MIT license.