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
534 commits 9 branches 28 tags 17 MiB
Find a file
Guilhem Niot e57ede23ed Use annotations reader without cache
2020-12-29 10:27:09 +01:00
.github/workflows Add php 8 support (#1745) 2020-12-10 21:59:36 +01:00
Annotation Merge pull request #1522 from ahilles107/port/options_support_in_model 2019-06-01 15:31:09 +02:00
Controller (feat): add utf-8 charset to response 2020-10-02 14:04:16 -03:00
DependencyInjection Use annotations reader without cache 2020-12-29 10:27:09 +01:00
Describer Apply StyleCI fixes 2020-08-06 10:26:59 +02:00
Exception Fix CS 2020-11-20 17:10:21 +01:00
Form/Extension Allow to not document form types fields (#1752) 2020-12-02 15:38:38 +01:00
Model Merge pull request #1522 from ahilles107/port/options_support_in_model 2019-06-01 15:31:09 +02:00
ModelDescriber Fix exposure of private/protected methods 2020-12-16 23:46:29 +01:00
PropertyDescriber Fix CS 2020-11-20 17:10:21 +01:00
Resources Use annotations reader without cache 2020-12-29 10:27:09 +01:00
RouteDescriber remove internal tag to avoid deprecation warnings 2020-09-20 12:53:27 +02:00
Routing Fix cs 2020-12-10 22:30:50 +01:00
SwaggerPhp Fix typos 2020-04-21 23:47:33 +02:00
Tests Fix exposure of private/protected methods 2020-12-16 23:46:29 +01:00
Util Supports reflection for routes configured in PHP files. (#1701) 2020-08-11 16:46:05 +02:00
.gitattributes Exclude development files from dist package 2020-09-28 10:36:17 -03:00
.gitignore Add php 8 support (#1745) 2020-12-10 21:59:36 +01:00
.php_cs.dist Fix build travis 2019-11-20 12:15:00 +01:00
.styleci.yml Update StyleCI config 2020-08-06 10:25:35 +02:00
ApiDocGenerator.php Implement alternative naming system via configuration (#1312) 2018-06-10 09:56:38 +02:00
CHANGELOG.md Release version 3.7 2020-08-12 11:06:17 +02:00
composer.json Use stable version of FOSRestBundle 2020-12-16 21:31:45 +01:00
CONTRIBUTING.md Add php 8 support (#1745) 2020-12-10 21:59:36 +01: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 Add php 8 support (#1745) 2020-12-10 21:59:36 +01:00
phpunit.xml.dist Allow Symfony 5 2019-11-29 13:59:27 +01:00
README.md Update build status with github actions 2020-12-22 11:27:56 +01:00
update-js.sh Include map files 2017-06-22 21:22:10 +02:00
UPGRADE-3.0.md Add exceptions in the upgrading command to warn about the requirement to run it on 2.x (#1501) 2019-04-11 20:54:16 +02: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, 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
git checkout 3.x
composer update

Then run the test suite:

./phpunit

License

This bundle is released under the MIT license.