Skip to content
/ app-api Public template
forked from yiisoft/app-api

API application project template

License

Notifications You must be signed in to change notification settings

iamsaint/app-api

 
 

Yii API template


Latest Stable Version Total Downloads Build status Scrutinizer Code Quality static analysis

API application template for Yii 3.

Installation

Install docker:

docker-compose up -d

Enter into the container:

docker exec -it yii-php bash

Install packages:

composer install

Usually the application is available at http://localhost:8080.

Endpoints:

Method Requires auth Description
GET / no get application info
GET /blog/ no get blog records
GET /blog/[id] no get blog record
POST /blog/ yes create blog record
PUT /blog/[id] yes update blog record
GET /users/ yes get users
GET /users/[id] yes get user
POST /auth/ no auth

Authorization is performed via the X-Api-Key header.

Codeception testing

./vendor/bin/codecept run

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

./vendor/bin/psalm

About

API application project template

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 100.0%