Download the PHP package paplauskas/apidocs without Composer

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

ApiDocs

What is this repository for?

A simple plug-and-play Laravel 5 package that will generate a nice API documentation page based on your documented routes.

List view

Setup

Do NOT install this package on your production environment unless you intend to make your API documentation public. In most cases it's best to keep it in the development environment.

Run this in your project folder:

composer require paplauskas/apidocs --dev

Add this to the config/app.php providers:

Paplauskas\ApiDocs\ApiDocsServiceProvider::class,

That's it!

How do I use it?

If setting up ApiDocs went well, you should be able to access it through /apidocs route (for example http://website.dev/apidocs).

Please note that you still have to document your endpoints by hand - ain't no magic here.

How to write documentation?

Just write comments right next to your routes. Api endpoint description format is pretty similar to the usual DocBlocks format. Write comments right before the route you wish to document. Example:

    /**
    * @title Upload an image
    * @description Uploads the original image to the server, resizes it.
    * @group Images
    * @param  image
    * @param  scale
    * @return stored image url
    */
    Route::post('images/upload', 'ImageController@upload');

    /**
    * Get image
    * Returns image info
    * @group Images
    * @param  imageID
    * @return path
    * @return alt
    * @return width
    * @return height
    */
    Route::get('images/{imageID}', 'ImageController@show');

As you probably noticed, @ title and @ description are optional tags - the first line is always treated as a title. @param, @return can be declared in several lines if you want to. Description line is optional and doesn't have to be specified at all. Use whatever format is more readable to you.

Package is smart enough to recognise group prefixes, so don't worry about them.

Undocumented routes are ignored.

ApiDocs checks for routes in the usual locations:

Found a bug?

File an issue in issue tracker.

All versions of apidocs with dependencies

PHP Build Version
Package Version
Requires php Version >=5.5.9
illuminate/support Version ~5
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 paplauskas/apidocs contains the following files

Loading the files please wait ....