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
d7ef725613
For the initial auto-scrolling to the selected route in location.hash:
- Fixed typo in the calculation of the offset-top position.
- Fixed requesting the selected route that has special chars (e.g. "/content/{page}")
- Fixed for refreshes with F5. It needs a setTimeout workaround to get that working in Webkit.
It needs also in Firefox a other dom element to fire scrollTop at.
Fixed also some old .delegation calls, which are deprecated in jQuery 1.7.
Why suppressing auto-scrolling on click:
When clicking through all methods it's very annoying when the browser always jumps to the clicked method,
especially when you go through all methods from bottom to up. This jump is unexpected and disturbing.
|
||
|---|---|---|
| Annotation | ||
| Command | ||
| Controller | ||
| DependencyInjection | ||
| EventListener | ||
| Extractor | ||
| Form/Extension | ||
| Formatter | ||
| Parser | ||
| Resources | ||
| Tests | ||
| Twig/Extension | ||
| Util | ||
| .gitignore | ||
| .travis.yml | ||
| composer.json | ||
| CONTRIBUTING.md | ||
| NelmioApiDocBundle.php | ||
| phpunit.xml.dist | ||
| README.md | ||
NelmioApiDocBundle
The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.
Important: This bundle is developed in sync with symfony's
repository.
For Symfony 2.0.x, you need to use the 1.* version of the bundle.
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