README

Generates and validate your OpenAPI documentation. Build up your your open api documentation in a way that you're familiar with, PHP Arrays. Instead of making a static documentation for all your modules that is always shown, you can use this generator to only generate the docs based on the modules you have installed at the moment.

When installing a new module you can generate the documentation again to inject that modules documentation to the bigger thing.

Also - it ships with Redoc (Github) so your clients can have a beatiful UI to look at when integrating to your API.

Installation

You can soon install the package via composer:

composer require rockymontana/oa-documentor

Usage

php artisan openapi:generate

Playground

If you want to try it out you can copy the docs-folder in tests into your project folder root and then run the generate command.

Then you can fiddle with the documentation and add new path files and components as you wish. When you're done, re-generate the docs and watch it in the browser.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email jonas@webbish.se instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

rockymontana / oa-documentor

Maintainers

Details