Download the PHP package solomon04/documentation without Composer

On this page you can find all versions of the php package solomon04/documentation. 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 solomon04/documentation

Informations about the package documentation

Laravel REST API Documenter

CircleCI Total Downloads Latest Stable Version License

Generate Documentation for your REST API

This package allows you to generate documentation for your REST API via annotations. The markdown is then served by LaRecipe to generate beautiful documentation for your API.

Note this package is NOT stable. I've used it for only one of my repo's.

Getting Started

Install LaRecipe

It is mandatory you install the LaRecipe package in order to get the benefits of the API documenter.

Install LaRecipe via composer.

composer require binarytorch/larecipe

Run the install command.

php artisan larecipe:install

Install Documenter

Install Documenter via composer

composer require solomon04/documentation

Publish provider

php artisan vendor:publish --provider="Solomon04\Documentation\DocumentationServiceProvider"

Steps

  1. Go to an API controller
  2. Add available annotations to the file.
  3. Run php artisan docs:generate

Available Annotations:

@Group

The group annotation is used to group endpoints within a single controller class.

Attributes
Example
@Meta

The meta annotation is used to document a single endpoint. This would be a function within a controller class.

Attributes
Example
@BodyParam

The body param annotation is used to document the available body parameters within a single endpoint request.

Attributes
Example
@QueryParam

The query param annotation is used to document the available query parameters within a single endpoint request.

Attributes
Example
@ResponseExample

The response example annotation is used to give an example response for an endpoint.

Important Note: Response example file must be stored in the storage/ directory.

Attributes
Example

Demo Laravel App

View an example of documentation using the Laravel REST API Documenter.

Tutorial

View a video tutorial here

All versions of documentation with dependencies

PHP Build Version
Package Version
Requires php Version ^7.3
minime/annotations Version dev-master
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 solomon04/documentation contains the following files

Loading the files please wait ....