yii2-extension yii2-promo

sablerom/yii2-promo

Package

This testwork yii2 extension. When this extension is used, a promo module with crud and rest api controllers will append to web app., _(*1)

Installation

WARNING! You need a pre-installed yii2 application with a connected database. The preferred way to install this extension is through composer., _(*2)

Just add, _(*3)

"sablesoft/yii2-promo": "*"

to the require section of your composer.json file and run, _(*4)

$ composer update

Migration

After the extension has been installed, start the migration:, _(*5)

$ ./yii migrate --migrationPath=vendor/sablesoft/yii2-promo/migrations

After that you can test the module through the browser and through the api requests., _(*6)

Web Browser Testing

Just open your installed yii2 application at route /promo and follow the instructions., _(*7)

Rest Api Testing

Use curl or any request service, such as Postman, to make api requests with different methods and parameters., _(*8)

Entry point:, _(*9)

http:/your-app.com/promo/api

You must use the authorization header of the form:, _(*10)

Authorization: Bearer <token>

For testing try tokens adminToken, demoToken and disabled token. Also use the header for json content ( Content-Type and Accept ). You can receive or change promo codes for both id and code., _(*11)

Example for getting some promo code by id:, _(*12)

$ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer adminToken" "http://localhost/promo/api/1"

Example for updating some promo code data by code:, _(*13)

$ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer adminToken" -X PUT \
-d '{"zoneName":"Minsk"}' "http://localhost/promo/api/test"

For more information about api actions check the Yii2 RESTful Web Services Guide, _(*14)

Code Docs

To generate the documentation, use the command, _(*15)

vendor/bin/apidoc api vendor/sablesoft/yii2-promo ./docs/api

For more info check the Yii2 original documentation., _(*16)