Download the PHP package langsys/swagger-auto-generator without Composer
On this page you can find all versions of the php package langsys/swagger-auto-generator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download langsys/swagger-auto-generator
More information about langsys/swagger-auto-generator
Files in langsys/swagger-auto-generator
Package swagger-auto-generator
Short Description Automatic Swagger and DTO Generator Docs Generator
License MIT
Informations about the package swagger-auto-generator
Laravel Langsys Swagger
THIS PACKAGE IS ON ALPHA, README IS FAR FROM COMPLETE. DO NOT USE IT YET. UNLESS YOU FEEL LIKE FIGURING IT OUT :)
This package is an extension for Laravel Data by Spatie and L5-Swagger by Darkaonline. It allows you to generate Swagger documentation and DTOs for your API based on the Laravel Data package.
Installation
You can install the package via composer:
Usage
You can publish the configuration file with:
You can customize the configuration file to fit your needs. The configuration file is located at config/langsys-generator.php
.
Modify the paths
array to point to the directory where your DataObjects and Langsys Schemas should be generated.
You can generate the Langsys Schemas by running the following command:
This will generate Swagger Schemas based on the configuration file.
To Generate the Data Objects, you can run the following command:
This will generate a DataObject for the User model.
Extended Usage
If you have custom fields in your Schemas, that do not exist in Laravel Default Helpers or Faker Functions, you can add your own custom functions to the config/langsys-generator.php
file.
In the above example, we have added a custom function locale
that generates a random locale string.
Here is an example of how the custom function looks like: