Download the PHP package byteit/openapi-spec-generator without Composer
On this page you can find all versions of the php package byteit/openapi-spec-generator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download byteit/openapi-spec-generator
More information about byteit/openapi-spec-generator
Files in byteit/openapi-spec-generator
Download byteit/openapi-spec-generator
More information about byteit/openapi-spec-generator
Files in byteit/openapi-spec-generator
Vendor byteit
Package openapi-spec-generator
Short Description Creates Open API spec for a Laravel JSON:API
License Apache-2.0
Package openapi-spec-generator
Short Description Creates Open API spec for a Laravel JSON:API
License Apache-2.0
Please rate this library. Is it a good library?
Informations about the package openapi-spec-generator
OpenAPI v3 Spec Generator
Designed to work with Laravel JSON:API
!!! Disclaimer: this project is work in progress and likely contains many bugs, etc !!!
What it can and can't
Can
- [x] Generate Schemas/Responses/Request/Errors for all default Laravel JSON:API routes
- [x] Use a seeded database to generate examples
Can't yet
- [ ] Customisation of the generation
- [ ] Generation for custom actions
- [ ] Generation for custom filters
- [ ] Generation for anything custom
- [ ] Generation for MorphTo relations (MorphToMany works)
- [ ] Generation of Pagination Meta
- [ ] Generation of Includes
- [ ] Generation of Authentication/Authorization
TODO
- [x] Command to generate to storage folder
- [x] Get basic test suite running with GitHub Actions
- [x] Add extra operation descriptions via config
- [x] Add in tags & x-tagGroups (via config)
- [x] Add tests (Use the dummy by laraveljsonapi to integrate all features)
- [ ] Add custom actions
- [x] Split schemas/requests/responses by action
- [ ] Consider field attributes
- [x] bool readonly
- [x] bool hidden
- [ ] closure based readonly (create/update)
- [ ] closure based hidden
- [x] List sortable fields
- [ ] Fix includes and relations
- [x] Add relationship routes
- [ ] Add includes
- [ ] Add authentication
- [ ] Add custom queries/filters
- [ ] Add a way to document custom actions
- [ ] Tidy up the code!!
- [x] Replace
cebe/php-openapi
withgoldspecdigital/oooas
- [x] Move to an architecture inspired by
vyuldashev/laravel-openapi
- [ ] Use php8 attributes on actions/classes to generate custom docs
🙏 Based upon initial prototype by martianatwork and glennjacobs
Usage
Install package
Publish the config file
Generate the Open API spec
Note that a seeded DB is required! The seeded data will be used to generate Samples.
Generating Documentation
A quick way to preview your documentation is to use Speccy. Ensure you have installed Speccy globally and then you can use the following command.
All versions of openapi-spec-generator with dependencies
PHP Build Version
Package Version
Requires
php Version
>=7.4|^8.0
laravel-json-api/hashids Version ^1.0@beta
goldspecdigital/oooas Version ^2.8
justinrainbow/json-schema Version ^5.2
symfony/yaml Version ^5.3
laravel-json-api/hashids Version ^1.0@beta
goldspecdigital/oooas Version ^2.8
justinrainbow/json-schema Version ^5.2
symfony/yaml Version ^5.3
The package byteit/openapi-spec-generator contains the following files
Loading the files please wait ....