Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thunken/docdocgoose
Generates a clean HTML'd API documentation. Based on your routes declarations and filtered patterns.
https://github.com/thunken/docdocgoose
api documentation generator laravel laravel-framework
Last synced: about 2 months ago
JSON representation
Generates a clean HTML'd API documentation. Based on your routes declarations and filtered patterns.
- Host: GitHub
- URL: https://github.com/thunken/docdocgoose
- Owner: thunken
- License: mit
- Archived: true
- Created: 2018-11-17T11:06:09.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-13T12:41:56.000Z (over 4 years ago)
- Last Synced: 2024-09-30T16:53:34.097Z (about 2 months ago)
- Topics: api, documentation, generator, laravel, laravel-framework
- Language: PHP
- Homepage:
- Size: 29.3 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Generates a clean HTML'd API documentation. Based on your routes declarations and filtered patterns.
# Install
```bash
composer require thunken/doc-doc-goose
```
Add
```php
Thunken\DocDocGoose\DocDocGooseProvider::class,
```
in *config/app.php* providers array
## Publish files (if you need some tweaks on config and views)
```bash
php artisan vendor:publish --provider="Thunken\DocDocGoose\DocDocGooseProvider"
```
## Config changes
```php
return [
'routes' => [
'v1' => [
'patterns' => [ 'api.v1.*' ],
'rules' => [
'headers' => [
'Authorization' => ''
]
]
]
],
'cache' => [
'enabled' => true,
'store' => 'file'
]
];
```
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
```php
'Extractor' => Thunken\DocDocGoose\Facades\Extractor::class,
```
in *config/app.php* facades array
# Usage
## In views
As simple as injecting
```php
{!! \Extractor::renderMenu() !!}
```
and / or
```php
{!! \Extractor::renderContent() !!}
```
in your templates.
## Use the raw extractor output
```php
$extractor = app(Extractor::class);
$extractor->extract();
/** @var array $docsAsArray */
$docAsArray = $extractor->toArray(); // returns an array
/** @var Collection $docsAsGroups */
$docsAsGroups = $extractor->toRaw(); // returns a Group Collection
```
# @TODOs
- Goals description
- Tests
- Tests
- And Tests
# References and thanks
* Widely and wisely using https://github.com/mpociot/laravel-apidoc-generator library (Thanks)