Skip to main content

A perfect tool for creating Restful web service in PHP

Project description

Rest CLI Build Status PyPI version Documentation

If you love ?

  • Beautiful restful web service with standard architecture
  • The fastest way to get things done with less human coding
  • Easy way to synchronize from components to documentation
  • Well tested structure with explicit request & response
  • Powered by an industrial framework with outstanding performance

Then this powerful tool is the right choice for you.

Prerequisite

  • Docker
  • Python 2.7 with pip
  • PHP 7.2 with composer

Installation

$ pip install rest-cli

Road map

  • <input type="checkbox" checked="" disabled="" /> Create web service base on a lightweight skeleton
  • <input type="checkbox" checked="" disabled="" /> Database schema migration
  • <input type="checkbox" checked="" disabled="" /> Reverse schema to model - repository - service and dependency injectors
  • <input type="checkbox" checked="" disabled="" /> Support built-in query annotations
  • <input type="checkbox" checked="" disabled="" /> Compile api routes and generate controller with integration tests
  • <input type="checkbox" checked="" disabled="" /> Serve and test application
  • <input type="checkbox" checked="" disabled="" /> Generate swagger documentation base on api routes (in-progress)
  • <input type="checkbox" disabled="" /> Support response header & type casting for complex Request
  • <input type="checkbox" disabled="" /> Support Service - Repository symbolic link to comply top down architecture
  • <input type="checkbox" disabled="" /> Export service interfaces for inter-communication
  • <input type="checkbox" disabled="" /> Support RPC exception via response verification

Usages

  1. Create web service application
  • --quite : Quite mode without asking anything about configuration
  • --force : Force creating application without complaining about existing project
  • --mysql : Start a mysql container with default information
$ rest create <awesome-service>
  1. Change directory to service and write some migrations at src/Shared/Migration
$ rest migrate
  1. Synchronize model - repository - service - controller - test cases
  • To create some awesome apis, update your routes at config/api/*.json
$ rest sync
  1. View route list
  • To see which routes are configured and manage apis
$ rest route
  1. Serve your application to test in browser
$ rest serve
  1. Test your application with PHPUnit
$ rest test
  1. Check current version
$ rest version
  1. Update new version of rest-cli ?
$ rest upgrade
  1. Need more help ?
$ rest --help

API Documentation

After rest sync you can serve your service with rest serve

Swagger Documentation should be ready at http://localhost:8000/docs

License

Rest CLI and related projects are licensed under the MIT

Thanks for the sponsor from GO1 Company

~ Happy Coding ~

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for rest-cli, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size rest_cli-0.0.3-py2.7.egg (33.3 kB) File type Egg Python version 2.7 Upload date Hashes View
Filename, size rest_cli-0.0.3-py2-none-any.whl (17.1 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size rest-cli-0.0.3.tar.gz (16.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page