Download the PHP package freedomcore/laravel-openapi without Composer

On this page you can find all versions of the php package freedomcore/laravel-openapi. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of freedomcore/laravel-openapi

Informations about the package laravel-openapi

Laravel OpenAPI

Simple to use OpenAPI 3 compatible documentation generator.
Also includes OpenAPI UI.
Total Downloads GuitHub Sponsor

About

  1. OAS3 support
  2. Automatic generation (assuming relevant configuration option is turned on)
  3. Includes of OpenAPI UI
  4. Uses PHP 8 Attributes

Requirements

This package developed on Laravel 8.19.0, but it might work on the previous releases.
All other requirements are inherited from the Laravel 8.

PHP 8 is required for this package to work

Installation

Install package through composer

Publish configuration files and views

Edit the openapi.php configuration file for your liking

What is included

Out of the box this package can work with FormRequest, it is also able to generate valid code for the method parameters when they are included in query | path, so there will be no duplicates and in: **** will also be assigned correctly.

Usage

FreedomCore\OpenAPI\Attributes\Controller

Controller attribute allows you to mark class as a Controller.
This will help generator to recognize classes and create appropriate tags for routes.

FreedomCore\OpenAPI\Attributes\Request\*

There are total of 5 types of requests currently supported by this package.

You dont have to use these Attributes unless you want to add description to the resource, possible request types will be inferred from Laravel routing system.

FreedomCore\OpenAPI\Attributes\Response\*

There are total of 18 types of responses currently supported by this package.
They do come with the correct response codes attached to them, so the only thing you have to do (or not) is add description.

This is the base class:

And this is the example of FreedomCore\OpenAPI\Attributes\Response\Ok response:

Example User.php Controller

And here is the WebUI look:

All versions of laravel-openapi with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
phpdocumentor/reflection-docblock Version ^5.2.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package freedomcore/laravel-openapi contains the following files

Loading the files please wait ....