PHP download

Download the PHP package chxj1992/php-apidoc without Composer

On this page you can find all versions of the php package chxj1992/php-apidoc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download chxj1992/php-apidoc
More information about chxj1992/php-apidoc
Files in chxj1992/php-apidoc

Vendor chxj1992
Package php-apidoc
Short Description Generate documentation for php API based application. No dependency. No framework required.
License MIT
Homepage https://github.com/calinrada/php-apidoc

Keywords generator documentation php api

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 chxj1992/php-apidoc

Informations about the package php-apidoc

php-apidoc

Generate documentation for php API based application. No dependency. No framework required.

Requirements
Installation
Usage
Available Methods
Preview
Tips
Known issues
TODO

Requirements

PHP >= 5.3.2

Installation

The recommended installation is via composer. Just add the following line to your composer.json:

Usage

Create an apidoc.php file in your project root folder as follow:

Then, execute it via CLI

Available Methods

Here is the list of methods available so far :

@ApiDescription(section="...", description="...")
@ApiMethod(type="(get|post|put|delete|patch")
@ApiRoute(name="...")
@ApiParams(name="...", type="...", nullable=..., description="...", [sample=".."])
@ApiHeaders(name="...", type="...", nullable=..., description="...")
@ApiReturnHeaders(sample="...")
@ApiReturn(type="...", sample="...")
@ApiBody(sample="...")

Preview

You can see a dummy generated documentation on http://calinrada.github.io/php-apidoc/

Tips

To generate complex object sample input, use the ApiParam "type=(object|array(object)|array)":

Known issues

I don't know any, but please tell me if you find something. PS: I have tested it only in Chrome !

TODO

Implement options for JSONP
Implement "add fields" option

All versions of php-apidoc with dependencies

PHP Build Version

Package Version

Version 1.3.7 Release 22. Sep 2017
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of php-apidoc from vendor chxj1992

Requires php Version >=5.3.2

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 chxj1992/php-apidoc contains the following files

Loading the files please wait ....