Download the PHP package laravel-openapi/codegen without Composer
On this page you can find all versions of the php package laravel-openapi/codegen. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download laravel-openapi/codegen
More information about laravel-openapi/codegen
Files in laravel-openapi/codegen
Package codegen
Short Description Generate laravel code from openapi specification.
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 codegen
Laravel OpenAPI Code Generation
Introduction
This package provides a convenient way to generate Laravel routes, requests, and controllers based on OpenAPI specifications in YAML format.
Motivation
For example, we have this openapi.yaml
by using package after running php artisan openapi:generate-code package generates for you below code.
routes/openapi-codegen.php
app/Http/Controllers/UsersController.php
app/Http/Requests/StoreUsersRequest.php
app/Http/Requests/UpdateUsersRequest.php
app/Http/Resources/UsersResource.php
Installation
To install the package, you can use Composer:
Configuration
After installing the package, you'll need to configure it to suit your project's needs. This package provides various configuration options to customize the code generation process.
Publishing Configuration
This command will create an openapi-codegen.php file in your Laravel application's config directory.
Configuration Options
In the openapi-codegen.php configuration file, you'll find the following options:
api_docs_url: Specifies the URL where the OpenAPI documentation will be accessible. This URL should point to the location of your OpenAPI specification file.-
entities: Defines the entities for which code generation will be performed. You can specify which entities should be generated by adding them to this array. Supported entities include:route: Generate Laravel routes based on OpenAPI paths.request: Generate request classes based on OpenAPI request bodies.resource: Generate resource classes for API responses.controller: Generate controllers for handling API requests.
By default, all supported entities will be generated. To exclude specific entities, simply remove them from this array.
paths: Specifies additional paths used in the application. Currently, only the routes_file option is available, which defines the file path where the OpenAPI routes will be generated.
Usage
Generate code
To generate Laravel code from an OpenAPI YAML file, you can use the following Artisan command:
This command will generate Laravel routes, requests, resource and controllers based on the provided OpenAPI YAML file.
Contributing
I welcome contributions from the community! If you have any ideas for improvements or find any issues, please feel free to open an issue or submit a pull request on GitHub.
License
This package is open-source software licensed under the MIT License.
Support
If you encounter any problems or have questions about using the package, please don't hesitate to reach out to us via email ([email protected]) or GitHub issues.
