A versatile documentation generator for APIs built with Laravel.
Explore the Documentation »
Herodot is a documentation generation framework, tailored for Laravel applications. It works by analyzing the source code of your application, and generating
documentation from it.
While everything usually works fine out of the box, Herodot is completely modular, configurable, and provides hooks and events in lots of interesting places.
Features:
Requirements:
Alternatives:
To start using Herodot, install it via composer:
php composer require matchory/herodot
Unless you've disabled package auto-discovery, Herodot should be installed and available. Otherwise, add the service provider to your config/app.php
:
'providers' => [
// ...
Matchory\Herodot\HerodotServiceProvider::class,
],
Herodot adds one central artisan command to your application:
php artisan herodot:generate
Executing it will start the documentation generation. You can do this now, safely: Herodot will analyze your code and generate documentation at public/docs
.
If this directory exists already, you will be prompted before anything is written.
By default, this should leave you with an HTML page, and an OpenAPI (aka. Swagger) definition. To configure the output formats, and any of the other settings,
you should publish the package configuration file:
php artisan vendor:publish --provider="Matchory\\Herodot\\HerodotServiceProvider" --tag="config"
This causes the configuration file to be published to config/herodot.php
. Check out the
configuration reference to learn about all available options.
Check out the documentation to learn how to document your API!
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
git checkout -b your-name/amazing-feature
)git commit -m 'Add some amazing feature'
)git push origin your-name/amazing-feature
)Distributed under the MIT License. See LICENSE for more information.