mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-04-03 22:03:33 +03:00
Generates documentation for your REST API from annotations
f5e38a283a
Key "statusCodes" for array with keys "method, uri, description, documentation, filters, requirements, parsedResponseMap, https, authentication, authenticationRoles, deprecated, id" does not exist in NelmioApiDocBundle::method.html.twig at line 182.
Sample:
/**
* Retrieves the list of categories (paginated) based on criteria.
*
* @ApiDoc(
* resource=true,
* output={"class"="Sonata\DatagridBundle\Pager\PagerInterface", "groups"={"sonata_api_read"}}
* )
*
*
* @QueryParam(name="page", requirements="\d+", default="1", description="Page for category list pagination")
* @QueryParam(name="count", requirements="\d+", default="10", description="Number of categories by page")
* @QueryParam(name="enabled", requirements="0|1", nullable=true, strict=true, description="Enabled/Disabled categories filter")
* @QueryParam(name="context", requirements="\S+", nullable=true, strict=true, description="Context of categories")
*
* @View(serializerGroups="sonata_api_read", serializerEnableMaxDepthChecks=true)
*
* @param ParamFetcherInterface $paramFetcher
*
* @return PagerInterface
*/
|
||
|---|---|---|
| Annotation | ||
| Command | ||
| Controller | ||
| DependencyInjection | ||
| EventListener | ||
| Extractor | ||
| Form/Extension | ||
| Formatter | ||
| Parser | ||
| Resources | ||
| Swagger | ||
| Tests | ||
| Twig/Extension | ||
| Util | ||
| .gitignore | ||
| .travis.yml | ||
| composer.json | ||
| CONTRIBUTING.md | ||
| DataTypes.php | ||
| NelmioApiDocBundle.php | ||
| phpunit.xml.dist | ||
| README.md | ||
NelmioApiDocBundle
The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.
Documentation
For documentation, see:
Resources/doc/
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