mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-08 18:49:26 +03:00

Go to file

Florian Strübe aa10f9a2da Introduced default-value parameter to JsonSerializableParser

JSP is now able to set a default value for scalar types
This makes merging the parser result with other parser results easier
and gives some additional info when creating docs

Removed PHP doc comment block

2015-11-10 14:34:53 +01:00

Annotation

Fix deprecated route options

2015-10-22 14:42:16 +02:00

Command

Added view option to api:doc:dump command

2015-05-26 18:09:29 +07:00

Controller

Introduce the concept of 'views'

2015-05-16 12:17:59 +02:00

DependencyInjection

Improve true/false/null default values on configuration

2015-06-07 11:34:26 +02:00

EventListener

make form and validation extractors optional

2013-10-28 19:12:43 +01:00

Extractor

[ISSUE-739] ApiDoc parameters setting will override lower parameter

2015-10-28 10:13:24 +01:00

Form/Extension

Fix deprecated FormType::setDefaultOptions usage

2015-06-05 09:34:11 +02:00

Formatter

Fix deprecated route options

2015-10-22 14:42:16 +02:00

Parser

Introduced default-value parameter to JsonSerializableParser

2015-11-10 14:34:53 +01:00

Resources

Let the js library set the proper Content-type header when sending files in sandbox - fixes #501

2015-10-27 17:29:36 +01:00

Swagger

Tests for aliased collections; Swagger formatting for wrapped collections.

2014-09-04 11:19:54 -07:00

Tests

Introduced default-value parameter to JsonSerializableParser

2015-11-10 14:34:53 +01:00

Twig/Extension

Using old array syntax

2015-10-01 09:55:48 +03:00

Util

abstracted docblock comment extraction, implemented in JmsMetadataParser to get parameter descriptions

2012-08-31 14:57:42 -04:00

.gitignore

Added phpunit.xml to the ignore file

2012-05-23 00:43:18 +02:00

.travis.yml

Include Symfony 2.7 stable on Travis and improve configuration

2015-06-04 12:20:14 +02:00

composer.json

Restore 5.3 compat (implicit)

2015-10-27 09:23:44 +01:00

CONTRIBUTING.md

Add a note about PR desc in CONTRIBUTING file

2013-11-14 12:07:19 +01:00

DataTypes.php

2015-03-06 11:19:08 +01:00

NelmioApiDocBundle.php

DunglasJsonLdApiBundle support

2015-03-20 09:53:48 +01:00

phpunit.xml.dist

Ignore vendor in code coverage

2012-04-13 15:21:45 +02:00

README.md

Fix broken image in README.md

2015-04-30 09:05:17 +02:00

README.md

NelmioApiDocBundle

The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.

Documentation

For documentation, see:

Resources/doc/

Read the documentation

Contributing

See CONTRIBUTING file.

Running the Tests

Install the Composer dev dependencies:

php composer.phar install --dev

Then, run the test suite using PHPUnit:

phpunit

Credits

The design is heavily inspired by the swagger-ui project. Some icons from the Glyphicons library are used to render the documentation.

License

This bundle is released under the MIT license. See the complete license in the bundle:

Resources/meta/LICENSE