- Composer
- Php 5.4 or latest
- MySql 5.x
composer -sdev create-project phprest/phprest-swagger-sample-project /path/to/your/project
In app/config/orm.php
set your database credentials.
create database tesselboard collate=utf8mb4_unicode_ci;
(from the root of your project dir)
vendor/bin/phprest-service-orm migrations:migrate
(from the root of your project dir)
vendor/bin/phprest-service-orm fixtures:set
(from the root of your project dir)
Storage dir (app/storage
) has to be writeable by the web server.
(from the root of your project dir)
vendor/bin/swagger -b public/bootstrap.php -u http://localhost/docs/jsondata api/ -o public/docs/jsondata
http://localhost/docs/index.html
(from the root of your project dir)
vendor/bin/phprest routes:get
You should get something like this:
Method | Route | Handler |
---|---|---|
OPTIONS | /{version:any}/camera | \Api\Camera\Controller\Camera::options |
GET | /{version:any}/camera | \Api\Camera\Controller\Camera::get |
POST | /{version:any}/camera | \Api\Camera\Controller\Camera::post |
GET | /{version:any}/temperatures | \Api\Temperature\Controller\Temperature::getAll |
POST | /{version:any}/temperatures | \Api\Temperature\Controller\Temperature::post |
OPTIONS | /{version:any}/temperatures | \Api\Temperature\Controller\Temperature::optionsAll |
OPTIONS | /{version:any}/temperatures/{id:number} | \Api\Temperature\Controller\Temperature::options |
GET | /{version:any}/temperatures/{id:number} | \Api\Temperature\Controller\Temperature::get |
DELETE | /{version:any}/temperatures/{id:number} | \Api\Temperature\Controller\Temperature::delete |
(from the root of your project dir)
cd specs
npm install
cd ..
vendor/bin/phprest-service-orm fixtures:set
specs/node_modules/jasmine-node/bin/jasmine-node --verbose specs/tests
- Separate your docs to an individual vhost
- Use API Blueprint for documentation instead of Swagger
- so you can eliminate your inner code API documentation
server {
listen 80;
server_name localhost;
root /var/www/application/public;
index index.php;
location / {
try_files $uri $uri/ @rewrite;
}
location ~ \.php$ {
fastcgi_split_path_info ^(.+\.php)(/.+)$;
fastcgi_pass unix:/var/run/php5-fpm.sock;
fastcgi_index index.php;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
include fastcgi_params;
}
location @rewrite {
rewrite ^ /index.php;
}
error_log /var/log/nginx/application_error.log;
}