https://github.com/flipboxfactory/craft-rest

REST application components for Yii2 and Craft CMS
https://github.com/flipboxfactory/craft-rest

craft3

Last synced: about 1 year ago
JSON representation

REST application components for Yii2 and Craft CMS

• Host: GitHub
• URL: https://github.com/flipboxfactory/craft-rest
• Owner: flipboxfactory
• License: mit
• Created: 2017-05-19T20:01:28.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-03-11T15:42:26.000Z (about 2 years ago)
• Last Synced: 2025-04-19T16:11:34.874Z (about 1 year ago)
• Topics: craft3
• Language: PHP
• Homepage:
• Size: 35.2 KB
• Stars: 19
• Watchers: 5
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# RESTful Application Components for Craft CMS

[![Join the chat at https://gitter.im/flipboxfactory/craft-rest](https://badges.gitter.im/flipboxfactory/craft-rest.svg)](https://gitter.im/flipboxfactory/craft-rest?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Latest Version](https://img.shields.io/github/release/flipboxfactory/craft-rest.svg?style=flat-square)](https://github.com/flipboxfactory/craft-rest/releases)

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)

[![Build Status](https://img.shields.io/travis/flipboxfactory/craft-rest/master.svg?style=flat-square)](https://travis-ci.org/flipboxfactory/craft-rest)

[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/flipboxfactory/craft-rest.svg?style=flat-square)](https://scrutinizer-ci.com/g/flipboxfactory/craft-rest/code-structure)

[![Quality Score](https://img.shields.io/scrutinizer/g/flipboxfactory/craft-rest.svg?style=flat-square)](https://scrutinizer-ci.com/g/flipboxfactory/craft-rest)

[![Total Downloads](https://img.shields.io/packagist/dt/flipboxfactory/craft-rest.svg?style=flat-square)](https://packagist.org/packages/flipboxfactory/craft-rest)

## Description

This package provides some RESTful specific components that are useful when building a RESTful api.  These components are used in a [RESTful Plugin for Craft](https://github.com/flipboxfactory/craft-restful); however they may also be used on their own if you wish to start from scratch.

## Installation

To install, use composer:

```

composer require flipboxfactory/craft-rest

```

## Usage

With this plugin as the scaffolding, you'll need to register and build your own RESTful endpoints.  We've created a [test project as a reference](https://github.com/flipboxlabs/craft-restful-project).

## Testing

``` bash

$ ./vendor/bin/phpunit

```

## Contributing

Please see [CONTRIBUTING](https://github.com/flipboxfactory/craft-rest/blob/master/CONTRIBUTING.md) for details.

## Credits

- [Flipbox Digital](https://github.com/flipbox)

## License

The MIT License (MIT). Please see [License File](https://github.com/flipboxfactory/craft-rest/blob/master/LICENSE) for more information.