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

RESTful API framework for Craft CMS
https://github.com/flipboxfactory/craft-restful

Last synced: about 1 year ago
JSON representation

RESTful API framework for Craft CMS

• Host: GitHub
• URL: https://github.com/flipboxfactory/craft-restful
• Owner: flipboxfactory
• License: other
• Created: 2018-01-14T18:21:16.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-01-23T04:40:24.000Z (over 2 years ago)
• Last Synced: 2025-04-15T23:44:50.000Z (about 1 year ago)
• Language: PHP
• Homepage:
• Size: 47.9 KB
• Stars: 5
• Watchers: 6
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# RESTful API for Craft CMS

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

[![Latest Version](https://img.shields.io/github/release/flipboxfactory/craft-restful.svg?style=flat-square)](https://github.com/flipboxfactory/craft-restful/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-restful/master.svg?style=flat-square)](https://travis-ci.org/flipboxfactory/craft-restful)

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

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

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

## Installation

To install, use composer:

```

composer require flipboxfactory/craft-restful

```

## 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-restful/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-restful/blob/master/LICENSE) for more information.