Download the PHP package nostop8/rest-api-doc without Composer
On this page you can find all versions of the php package nostop8/rest-api-doc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
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 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.
Informations about the package rest-api-doc
yii2-rest-api-doc
Simple documentation generator for Yii2 REST applications based on defined API endpoints and actions annotations.
Installation
- Run
composer require nostop8/rest-api-doc;
Alternatively add into require section of your composer.json following string "nostop8/rest-api-doc": "*" and run composer update
-
In your application config file inside
modulessection add - In your application config file inside
bootstrapsection add:
Please, note. You may change documentation into any other word, which would be better to call documentation for your REST API.
- Now run your application at
http://<yourappdomain>/documentationand if you did everything correct, you shoul see something like this:
Usage
- First of all you should know that this documentation generator will work only in case you define your REST API endpoints using following principles: http://www.yiiframework.com/doc-2.0/guide-rest-routing.html
- Currently you can define for you endpoints following annotations types, which will be later displayed/provided by API documentation generator:
- Rest Description: Your endpoint description.
- Rest Fields: ['field1', 'field2'] or ['field3', 'field4']. (Please, note:
orand array after it is extra and might be skipped if your service accepts only one type of body) - Rest Filters: ['filter1', 'filter2'].
- Rest Expand: ['expandRelation1', 'expandRelation2'].
- In case you are using CRUD services, which does not require endpoints to be defined (because they are already predefined inside
yii\rest\UrlRule- http://www.yiiframework.com/doc-2.0/yii-rest-urlrule.html and implemented inside\yii\rest\ActiveController) and you still want to add some description, define in your controller empty methods with the same names (e.g. actionCreate, actionUpdate etc.) and add annotations to them as you would do for other actions implemented by you.
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.
Extra Tip
While developing API which should be depended on 3-rd party that are not available yet for some reason, it might be useful for you to use an external online API mocking tool - QuickMocker. It is also useful while integrating your application with webhooks to debug requests that arrive from some 3-rd party while you do not host your application remotely.
