Download the PHP package chemezov/yii2-rest-api-doc without Composer

On this page you can find all versions of the php package chemezov/yii2-rest-api-doc. 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 yii2-rest-api-doc

yii2-rest-api-doc

Simple documentation generator for Yii2 REST applications based on defined API endpoints and actions annotations.

Installation

Alternatively add into require section of your composer.json following string "chemezov/yii2-rest-api-doc": "1.0" and run composer update

Please, note. You may change documentation into any other word, which would be better to call documentation for your REST API.

Usage

  1. Rest Title: Your endpoint title.
  2. Rest Description: Your endpoint description.
  3. Rest Fields: ['field1', 'field2'] or ['field3', 'field4']. (Please, note: or and array after it is extra and might be skipped if your service accepts only one type of body)
  4. Rest Filters: ['filter1', 'filter2'].
  5. Rest Expand: ['expandRelation1', 'expandRelation2'].

Example of annotations

As you may see from this example, every annotation starts with its name and collon (:) and ends with a dot (.). Also the body of every annotation type might consist of PHP array. You must follow this rules in order to define properly documentation description and service testing functionality.


All versions of yii2-rest-api-doc with dependencies

PHP Build Version
Package Version
Requires yiisoft/yii2 Version *
bower-asset/jquery Version >=1.11.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 chemezov/yii2-rest-api-doc contains the following files

Loading the files please wait ....