RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-04-03 22:03:33 +03:00
Code Issues Projects Releases Wiki Activity
Generates documentation for your REST API from annotations
224 commits 9 branches 28 tags 17 MiB
Find a file
Michelle Sanver 7d01a420fa Made nelmio_api_doc.generator a public service 
The service was not defined public or private, which threw deprecation notices in the tests where we use it from the container. It is now declared public explicitly to not have deprecations.
2018-01-15 17:05:34 +01:00
Annotation Apply fixes from StyleCI 2017-12-22 17:42:18 +00:00
Controller Add areas support (#1169) 2018-01-05 13:08:02 +01:00
DependencyInjection Always require phpdocumentor/reflection-docblock (#1186) 2018-01-13 14:18:13 +01:00
Describer Fix Api-Platform support 2018-01-04 18:08:14 +01:00
Model Cleanup 2018-01-04 11:34:23 +01:00
ModelDescriber Always require phpdocumentor/reflection-docblock (#1186) 2018-01-13 14:18:13 +01:00
Resources Made nelmio_api_doc.generator a public service 2018-01-15 17:05:34 +01:00
RouteDescriber Apply fixes from StyleCI 2017-12-22 17:42:18 +00:00
Routing Change the behavior of path_patterns filter to use OR instead of AND 2017-06-07 13:55:32 +02:00
SwaggerPhp Fix the invalid reference notice 2017-08-27 17:41:42 +02:00
Tests Use @SWG\Parameter type when set instead of throwing (#1174) 2018-01-11 12:26:59 +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 Update Travis config 2017-12-17 10:46:20 +01:00
ApiDocGenerator.php Add areas support (#1169) 2018-01-05 13:08:02 +01:00
CHANGELOG.md Add areas support (#1169) 2018-01-05 13:08:02 +01:00
composer.json Always require phpdocumentor/reflection-docblock (#1186) 2018-01-13 14:18:13 +01: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 Use phpunit 6 2017-05-31 19:36:17 +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 make upgrade instructions depend on stable version 2017-12-18 08:41:18 +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.