Shuffle is a bundle for Laravel that creates API documents without needing you to create PHPDoc comments by hand. The UI uses Limelight Components to give interactive API Docs with embeddable React or Internet Elements, powered by OpenAPI as well as Markdown.
The primary adage of [Scramble] is to create as much API documents instantly as feasible. This enables you to concentrate on code as well as prevent annotating every feasible param/field as it might cause out-of-date documents. By creating docs instantly from the code your API will certainly constantly have current documents you can rely on.
After setting up Shuffle in your Laravel API job, you will certainly obtain 2 brand-new courses: / docs/api to see our API documents, as well as / docs/api. json which is an Open API record in JSON style made use of to define your API.
Shuffle counts on fixed evaluation as well as Laravel conventions to create as much documents as feasible for you, with the capability to supplement the automated documents with comments. Component of what Shuffle does is check kind demands or a contact us to validate() to record needed specifications.
Various other cool functions consist of:
- Configurable path resolution making use of the
Shuffle:: courses()technique - Paperwork permission entrance
- Web server arrangement
- Record protection system making use of usual conventions like JWT, Basic, OAuth2, and so on
- Expansions API
- And Also extra
To start with Shuffle, you can have a look at the Getting going documents, that includes installment, arrangement, as well as extra. You can discover more concerning this plan, obtain complete installment directions, as well as watch the resource code on GitHub.
