Download the PHP package thunken/doc-doc-goose without Composer
On this page you can find all versions of the php package thunken/doc-doc-goose. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download thunken/doc-doc-goose
More information about thunken/doc-doc-goose
Files in thunken/doc-doc-goose
Package doc-doc-goose
Short Description A laravel REST API doc generator
License MIT
Homepage https://github.com/thunken/doc-doc-goose
Informations about the package doc-doc-goose
Generates a clean HTML'd API documentation. Based on your routes declarations and filtered patterns.
Install
Add
in config/app.php providers array
Publish files (if you need some tweaks on config and views)
Config changes
Here you can manage versions, headers by version and caching feature.
Cache
Cache is enable by default and using the file store, you can disable it by putting 'enable' to false.
File cache is the best cache method if your cache files are not persisted across deployment. It's a good way to ensure your documentation is up to date with the current version of your API code at each deployment. You can reproduce this behavior by resetting the Extractor::cacheName key in your choosen cache store.
Facade
Already declared in provider so this should be useless. Still, to do so, add
in config/app.php facades array
Usage
In views
As simple as injecting
and / or
in your templates.
Use the raw extractor output
@TODOs
- Goals description
- Tests
- Tests
- And Tests
References and thanks
- Widely and wisely using https://github.com/mpociot/laravel-apidoc-generator library (Thanks)
All versions of doc-doc-goose with dependencies
mpociot/laravel-apidoc-generator Version ^4.2