mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-04-02 21:36:14 +03:00

Generates documentation for your REST API from annotations

Find a file

Javier Spagnoletti df9893428e [JMSModelDescriber] Allow to use free form objects from JMS serialization (#1368 ) * [JMSModelDescriber] Allow to use free form objects from JMS serialization * Remove unused variable * Refactor `describeItem()` * Add more tests * early detect of free form objects * Add test for array property without type * Merge `findPropertyType()` and `registerPropertyType()` methods * Update `registerPropertyType()` in order to set "object" as type for arrays with undefined item types * Set "additionalProperties" definition for arrays without defined items * Simplified `registerPropertyType()` * Merged `registerPropertyType()` into `describeItem()` * Fix comment * Fix comment		2018-08-21 17:41:32 +02: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	jms serializer groups can be nested (#1366 )	2018-07-25 17:58:28 +02:00
Describer	Merge SWG annotations in manually created `@Operation` (#1321 )	2018-06-02 13:48:44 +02:00
Form/Extension	Add a documentation form extension (#1234 )	2018-02-19 10:56:51 +01:00
Model	Implement alternative naming system via configuration (#1312 )	2018-06-10 09:56:38 +02:00
ModelDescriber	[JMSModelDescriber] Allow to use free form objects from JMS serialization (#1368 )	2018-08-21 17:41:32 +02:00
Resources	Fix path for template extension	2018-08-13 09:05:06 +02:00
RouteDescriber	Remove unused variable (#1340 )	2018-06-07 20:27:21 +02:00
Routing	Allow to filter routes by host (#1121 )	2018-03-17 10:37:54 -03:00
SwaggerPhp	Support ``@Model`` in in-object annotations	2018-03-22 19:14:01 +01:00
Tests	[JMSModelDescriber] Allow to use free form objects from JMS serialization (#1368 )	2018-08-21 17:41:32 +02: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

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.