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

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

Informations about the package laravel-request-docs

Laravel Request Docs

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

Fast: Install on any Laravel Project

Hassle Free: Auto Generate API Documentation for request rules and parameters

Analyze: In built SQL query time analyzer, response time and headers output.

Supports: Postman and OpenAPI 3.0.0 exports.

Features

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
Laravel 6. or 8. or 9.*

Installation

You can install the package via composer:

You can publish the config file with:

Usage

Dashboard

View in the browser on /request-docs/

Generate a static HTML and open api specification

Docs HTML is generated inside docs/.

Just want Open API

View in the browser on /request-docs/?openapi=true

Design pattern

In order 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

Generated API documentation

Preview

Try API

Preview

SQL query profile

Preview

Response profile

Preview

Customize Headers

Preview

Extra

You write extra documentation in markdown which will be rendered as HTML on the dashboard. Example of using it in controller

Custom Params

You write extra params with rules with @QAparam comment line

Testing

Linting

Fixing lints

Changelog

All versions of laravel-request-docs with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4|^8.0
illuminate/contracts Version ^8.37|^9.0
kitloong/laravel-app-logger Version ^1.0
spatie/laravel-package-tools Version ^1.4.3
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 macerd/laravel-request-docs contains the following files

Loading the files please wait ....