Download the PHP package icodestuff/ladocumenter without Composer

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

Informations about the package ladocumenter

logo

CircleCI Total Downloads Latest Stable Version License

Automatically generate beautiful API documentation for your Laravel API routes using annotations.

Installation

PHP 7.4 and Laravel 7 or higher are required.

Installing

You will need LaRecipe to serve your autogenerated markdown

run composer require --dev binarytorch/larecipe && composer require --dev icodestuff/ladocumenter to download both LaRecipe and LaDocumenter as a dev dependency

Then php artisan larecipe:install to install Larecipe

And lastly publish the config php artisan vendor:publish --provider="Icodestuff\LaDocumenter\LaDocumenterServiceProvider"

Demo Video

Here is a YouTube video showcasing the LaDocumenter package

Demo

Getting Started

The only endpoints that are documented are the ones in your api.php file.

Generating Documentation

In order to compile your annotations to markdown you will need to run:

php artisan ladocumenter:generate

Grouping Endpoints

All endpoints are grouped for easy organization. Only use @Group to group endpoints in a single controller class by adding it to the top of the controller like so:

Example
Attributes

Documenting Endpoints

The @Endpoint annotation is used for a single controller method or endpoint. Note, at this time we don't support closures or resources 😕

Example

Attributes

Specifying Request Parameters

To specify a list of valid parameters your API route accepts, use the @QueryParam or @BodyParam.

Both the @BodyParam & @QueryParam annotation takes the name, type, required, description and an example.

@BodyParam Example

@QueryParam Example

Attributes

Generating Responses

To generate a response, you must use the @ResponseExample annotation. This takes in the status of the response as well as a link to the response file like so:

Attributes

Be sure to add your responses to the storage directory as that is where LaDocumenter looks for them. We recommend automatically generating responses using Laravel's testing suite.

Indicating Authentication Status

LaDocumenter automatically labels an endpoint as authenticated if the route uses the middleware defined in the config/ladocumenter.php file:

If you are using a separate auth middleware, be sure to define it in the config file.


All versions of ladocumenter with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4
minime/annotations Version dev-master
myclabs/php-enum Version ^1.7
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 icodestuff/ladocumenter contains the following files

Loading the files please wait ....