Download the PHP package rakutentech/laravel-request-docs without Composer

On this page you can find all versions of the php package rakutentech/laravel-request-docs. 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 rakutentech/laravel-request-docs

Informations about the package laravel-request-docs

Laravel Request Docs

The Hassle-Free automatic API documentation generation for Laravel.
A Swagger alternative.
Supports Open API 3.0.0

Try latest DEMO!

CI Node CI PHP codecov Latest Stable Version Total Downloads

Fast Install on any Laravel Project

Hassle Free Auto Generate API Documentation for request rules and parameters

Analyze Inbuilt SQL query time analyzer, response time and headers output.

Supports Postman and OpenAPI 3.0.0 exports.

Features

Read on Medium

Automatically generate API documentation for Laravel without writing annotations.

Read more: https://medium.com/web-developer/laravel-automatically-generate-api-documentation-without-annotations-a-swagger-alternative-e0699409a59e

Requirements

Lang Versions
PHP 7.4 or 8.0 or 8.1 or 8.2
Laravel 6. or 8. or 9. or 10.

Installation

You can install the package via composer:

You can publish the config file with:

(optional) Add the following middleware to your API, so that the SQL logs and model events are captured.

app/Http/Kernel.php

Usage

Dashboard

View in the browser on /request-docs/

Design pattern

For this plugin to work, you need to follow the design pattern by injecting the request class inside the controller. For extra documentation you can use markdown inside your controller method as well.

Design pattern

Screenshots

Dark and Light Modes

Settings to sort, group and filter

Extra documentation

You can write extra documentation in markdown using @lrd in the PHPDoc on the rules method of the Request classes and on the controller methods.\ This will then be rendered as HTML on the dashboard.\ Documentation defined on the controller method is appended below documentation defined on the rules method.\ Example of using it in the controller:

Extra parameters

You define extra parameters using @LRDparam.\ You can use @LRDparam in PHPDoc on both the rules methods and the controller methods.\ You can also overwrite rules using @LRDparam. Meaning, when rules are defined in the rules method, you can overwrite those rules using @LRDparam in the PHPDoc above the rules method. And you can overwrite those rules using @LRDparam in a PHPDoc on the controller methods.\ So, the precedence is Controller method PHPDoc < Rules method PHPDoc < Rules method values.

Response codes

Without explicitly declaring response codes, all routes are documented to return any of the response codes defined in the request-docs.php default_responses configuration.\ However, using @LRDresponse 200|422 (spaces or pipes) within the PHPDoc on your controller methods, you are able to explicitly define what status codes can be returned by the server.

Configuration

Please view the request-docs.php config file to see how you can customise your experience.

Testing

Linting

Fixing lints

Star History

Star History Chart

Changelog

Contributors

All versions of laravel-request-docs with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4|^8.0|^8.1|^8.2|^8.3
illuminate/contracts Version ^8.37|^9.0|^10.0|^11.0
kitloong/laravel-app-logger Version ^1.0
spatie/laravel-package-tools Version ^1.4.3
ext-json Version *
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 rakutentech/laravel-request-docs contains the following files

Loading the files please wait ....