Download the PHP package vegas-cmf/apidoc without Composer

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

Informations about the package apidoc

Vegas CMF API Documentor

Build Status Coverage Status Latest Stable Version Total Downloads SensioLabsInsight

Usage

Add vegas-cmf/apidoc to composer.json dependencies

and run composer update

Create CLI task which extends \Vegas\ApiDoc\Task\GeneratorTaskAbstract.php

Add annotations to controllers classes

Available parameters:
Class

name Name of endpoint

description Detailed description of the API endpoint

version API version

Method

name Name of API method

description Detailed description of the API method

method Determines HTTP method (POST, GET, ...)

url Request path

params Describes parameters passed to API method

headers Describes headers passed in request e.g. for Authorization

request Describes request

requestContentType Determines request Content-Type

requestFormat Determines request format

requestExample Example of request body

response Describes response

responseContentType Determines response Content-Type

responseFormat Determines response format

responseExample Example of response body

responseCodes Describes response status codes

Create documentation layout ( you can use sample layout from tests/fixtures/app/layouts/partials/apiDoc directory ) and prepare output directory

Run CLI Task to generate documentation

See sample http://jsbin.com/xeyetevuro/1

All versions of apidoc with dependencies

PHP Build Version
Package Version
Requires php Version >=5.4
ext-phalcon Version >=1.3.0,<2
phalcon/devtools Version 1.3.x-dev
phalcon/incubator Version 1.3.*
vegas-cmf/core Version 1.*
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 vegas-cmf/apidoc contains the following files

Loading the files please wait ....