Download the PHP package ark4ne/laravel-openapi-generator without Composer
On this page you can find all versions of the php package ark4ne/laravel-openapi-generator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ark4ne/laravel-openapi-generator
More information about ark4ne/laravel-openapi-generator
Files in ark4ne/laravel-openapi-generator
Package laravel-openapi-generator
Short Description OpenApi - Laravel Documentation Generator
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-openapi-generator
OpenApi - Laravel Documentation Generator
A OpenApi documentation generator for Laravel.
Installation
Usage
Config
...
Versions
The "Versions" section allows you to specify different configurations for each version of your API.
output-file
Output-file name.
title
Document title.
description
Document description.
routes
Define which routes will be processed. The pattern must be a shell mask.
groupBy
Document description. Used to group API routes.
by
Define a group by according to :
- controller : The route controller class
- uri : The route uri
- name : The route name
regex
Define a regex that will retrieve the name of the group.
ex:
With this, routes will be grouped by controller class name.
ignore-verbs
HTTP verbs to ignore.
Parses
Define all parser used for documentate a specific class.
For each object, only one parser will be used.
For instance :
ResourceCollectionParser and JsonResourceParser are eligible, because
MyResourceCollection extends from ResourceCollection which extends from JsonResource.
The order of the parsers will define which parser we will use: 1st eligible => parser used.
For MyResourceCollection we will therefore use ResourceCollection.
requests
Requests parsers.
rules
Request rules parsers.
responses
Responses parsers.
middlewares
Surcharge global middlewares config.
@see Middlewares
Format
date
Defines how date formats will be understood.
Middlewares
Defines middlewares transformers.
For each middlewares, you can define a transformer that will be used to transform the request or responses.
Connections
use-transaction
Defines whether to use transactions on different database connections.
Using transaction will create and save models via factories. The saved models will be deleted at the end of the generation via a rollback.
Without transactions, models will be created but not saved, which can lead to errors during generation.
All versions of laravel-openapi-generator with dependencies
laravel/framework Version ^8.0|^9.0|^10.0|^11.0
goldspecdigital/oooas Version ^2.10
phpdocumentor/reflection-docblock Version ^5.3
phpdocumentor/type-resolver Version ^1.6
justinrainbow/json-schema Version ^6.0