Download the PHP package 3sidedcube/laravel-redoc without Composer

On this page you can find all versions of the php package 3sidedcube/laravel-redoc. 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 3sidedcube/laravel-redoc

Informations about the package laravel-redoc

3 Sided Cube

Laravel Redoc

Latest Version on Packagist Total Downloads GitHub Actions

This package provides an easy way for rendering API documentation using OpenAPI and Redoc.

Installation

You can install the package via composer:

Usage

Viewing the documentation

By default, the documentation is served at /docs/api and will load the openapi.json file from the openapi folder at the root of the project.

You can change the path used to serve the documentation by setting the redoc.path config option.

If you would like to change the directory where your openapi.json file is located, you can update redoc.directory config option.

Documentation versions

Laravel Redoc supports rendering multiple versions of documentation. If you would like to serve a different version of the documentation, you can include {version} in the redoc.path config option e.g. docs/{version}/api. This will then load the {version}.json file from the configured directory.

Variables

If you would like to replace a "variable" in the documentation, you can use the redoc.variables config option.

For example, if you would like to dynamically set the server url to the given environment, you could configure the following variable:

Now, when you use :server_url in the OpenAPI definition, it will be replaced with the value of the APP_URL.

Testing

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

License

Laravel Redoc is open-sourced software licensed under the MIT license.

All versions of laravel-redoc with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4|^8.0|^8.1|^8.2|^8.3
illuminate/routing Version ^8.0|^9.0|^10.0|^11.0
illuminate/support Version ^8.0|^9.0|^10.0|^11.0
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 3sidedcube/laravel-redoc contains the following files

Loading the files please wait ....