Download the PHP package blacknell/restapi-service without Composer

On this page you can find all versions of the php package blacknell/restapi-service. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of blacknell/restapi-service

Informations about the package restapi-service

A simple class to expose a RESTful api

Build Status Latest Stable Version Latest Unstable Version License

restapi-service maps REST API calls to endpoints in protected methods in your derived class. In your class methods process according to the verbs and arguments of the http request.

Installation

Install the latest version with

Basic Usage

Web Server configuration

For example, https://yourserver/myapi/v1/daylight/littlehampton/yesterday maps to https://yourserver/myapi/v1/api.php?request=daylight/littlehampton/yesterday

Sample code

See example/MyAPI.class.php to see how https://yourserver/myapi/v1/daylight/littlehampton/yesterday generates the following JSON output

Additional Concepts

Cross-Origin Resource Sharing (CORS)

Additional headers can be added to the constructor of your derived class before calling the parent constructor. For example, to allow a client on a website http://myclient.com to access your API add this header call.

Authentication

Overide RestAPI::isAuthenticated() to handle authentication and only return true if the request is authorised. As a basic example, you could enforce a request to include a header such as Authentication-Token: xxx and test this in your derived class.

Error Handling

Any endpoint not mapping to a protected function in your derived class results in the following JSON response.

Your derived class should do the same for invalid verbs or arguments. Methods other than GET, POST, PUT or DELETE also result in an error.

Logging

PSR-3 logging is supported via monolog/monolog by passing an optional Logger object to the API constructor.

All versions of restapi-service with dependencies

PHP Build Version
Package Version
Requires monolog/monolog Version ^2.0
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package blacknell/restapi-service contains the following files

Loading the files please wait ....