Download the PHP package codev/apidocs without Composer

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

Laravel API Docs Generator

This Laravel package provides an API Documentation generator based upon your Routes and Controller Method DocBlock comments. Packagist: https://packagist.org/packages/codev/apidocs

Installation

Laravel 5.0 -> 8.0

Begin by installing this package through Composer. Edit your project's composer.json file to require codev-vn/apidocs.

composer require --dev codev/apidocs

Next, update Composer from the Terminal:

composer update

Once the packaage has installed, the final step is to add the service provider. Open config/app.php, and add a new item to the providers array.

'Codev\Apidocs\ApidocsServiceProvider',

Run the artisan command from the Terminal to see the new apidocs command.

php artisan apidocs:generate

Create a copy of the API Docs Config by running this artisan command:

php artisan vendor:publish

Notes

Route Prefix

Create a prefix for your routes with an API Version. i.e. 'api/v1

Route::group(['prefix' => 'api/v1'], function(){
     // ...
});

######## Laravel 5.4 defaults to api prefix (Route::prefix('api')). If your routes/api.php looks like this...

Route::group(['prefix' => 'v1'], function(){
     // ...
});

... then the route for the generate command would be api/v1 Otherwise it will be just api

DocBlock Example

Below is a docBlock example.

/**
* Display the specified resource.
* GET /user/{id}
*
* @param  int  $id  The id of a User
* @return Response
*/
public function show($id)
{
    // Display User
}

License

This package we are developing from https://packagist.org/packages/f2m2/apidocs. We ask for permission from F2M2 to use the source code to further develop the project and serve the community. Thanks F2M2.

Codev Service Co.,Ltd at https://codev.vn

See LICENSE file.

All versions of apidocs with dependencies

PHP Build Version
Package Version
Requires illuminate/support Version ^8.41
php Version ^7.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 codev/apidocs contains the following files

Loading the files please wait ...