floor9design/laravel-restful-api

A set of restful API classes that offer strict RESTful methods for laravel

dev-master 2024-11-13 08:52 UTC

Requires

• php: >=7.4
• ext-json: *
• doctrine/inflector: ^2.0
• floor9design/json-api-formatter: *
• symfony/yaml: ^v5.0.0

Requires (Dev)

• mockery/mockery: dev-master
• orchestra/testbench: ^5.0
• phpunit/phpunit: ^9.0

MIT

• Rick Morice

• rest
• api
• laravel
• floor9design

README

A set of restful API classes that offer strict RESTful methods for laravel. Currently in development.

Introduction

Laravel's out the box RESTful implementation is fairly easy to use, but it is not a strict REST api. This repository offers classes to deliver a true REST implementation that matches the wikipedia definition.

• Wikipedia definition

Features

• Simple setup/configuration
• Simple "plug-in" traits and interfaces that quickly add a full set of RESTful responses to a controller
• JSON API compliant responses
• Not implemented/not allowed/data responses available on a per method/route basis
• Easily overrideable by your own code on a per method/route basis
• Suports laravel validation

Install

Via Composer

composer require floor9design/laravel-restful-api

Usage

It is recommended you read the background information section:

• background

This is defined in detail in the usage section:

• usage

Setup

This is defined in detail in the setup section:

• setup

Testing

Tests under development and are underway.

To run the existing tests:

• ./vendor/phpunit/phpunit/phpunit

Documentation and coverage can be generated as follows:

• ./vendor/phpunit/phpunit/phpunit --coverage-html docs/tests/

Credits

• Rick

Changelog

A changelog is generated here:

• Change log

License

This software is available under the MIT licence.

• License File