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
243 commits 9 branches 28 tags 17 MiB
Find a file
Roman Borysenko c048adf7b7 Update index.rst (#1223) 
* Update index.rst

* Create faq.rst

Frequently Asked Questions added

* Update faq.rst

* Update index.rst

Comment removed

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst
2018-02-13 17:13:09 +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 Inject the AnnotationsReader in Model describers instead of internal classes (#1203) 2018-01-24 19:58:38 +01:00
Describer Added support for @Security annotations (#1201) 2018-01-25 21:11:34 +01:00
Model Cleanup 2018-01-04 11:34:23 +01:00
ModelDescriber FormModelDescriber: set type to array with correct example for multiple choices form. (#1212) 2018-02-03 12:52:43 +01:00
Resources Update index.rst (#1223) 2018-02-13 17:13:09 +01:00
RouteDescriber Add a missing variable initialisation 2018-01-26 07:37:03 +01: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 Added test for the Symfony constraints (#1213) 2018-02-05 18:39:58 +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 Change 3.1.0 release date 2018-01-28 13:56:02 +01:00
composer.json Allow EXSyst/swagger ~0.4 2018-02-03 17:54:48 +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.