Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rockymontana/oadocumentor
Generates and validates OpenAPI documentation
https://github.com/rockymontana/oadocumentor
laravel laravel-pac openapi openapi-codegen
Last synced: 3 days ago
JSON representation
Generates and validates OpenAPI documentation
- Host: GitHub
- URL: https://github.com/rockymontana/oadocumentor
- Owner: rockymontana
- License: mit
- Created: 2019-09-19T11:43:24.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-09-23T13:08:39.000Z (over 5 years ago)
- Last Synced: 2024-11-29T00:51:27.842Z (about 2 months ago)
- Topics: laravel, laravel-pac, openapi, openapi-codegen
- Language: PHP
- Size: 11.7 KB
- Stars: 2
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenApi Documentation Generator
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](https://redocly.github.io/redoc/) ([Github](https://github.com/Redocly/redoc)) 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:
```bash
composer require rockymontana/oa-documentor
```
## Usage
``` bash
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](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
### Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Jonas Erlandsson](https://github.com/rockymontana)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.