Compare commits
9 Commits
57451a1471
...
fa49910d82
Author | SHA1 | Date |
---|---|---|
Steve Boyd | fa49910d82 | |
Guy Sartorelli | 243fbd0cd3 | |
Guy Sartorelli | 5170146d07 | |
Sabina Talipova | f110752973 | |
Guy Sartorelli | 39614ba6e1 | |
Guy Sartorelli | e5c349b1b1 | |
Guy Sartorelli | 729494737d | |
Guy Sartorelli | 45883df8c0 | |
Guy Sartorelli | 1376bb4d41 |
12
README.md
12
README.md
|
@ -3,6 +3,12 @@
|
|||
[![CI](https://github.com/silverstripe/silverstripe-restfulserver/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-restfulserver/actions/workflows/ci.yml)
|
||||
[![Silverstripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
composer require silverstripe/restfulserver
|
||||
```
|
||||
|
||||
## Overview
|
||||
|
||||
This class gives your application a RESTful API. All you have to do is set the `api_access` configuration option to `true`
|
||||
|
@ -10,12 +16,6 @@ on the appropriate DataObjects. You will need to ensure that all of your data m
|
|||
your model layer (ie, the DataObject classes) and not in your Controllers. This is the recommended design for SilverStripe
|
||||
applications.
|
||||
|
||||
## Requirements
|
||||
|
||||
* Silverstripe 4.0 or higher
|
||||
|
||||
For a Silverstripe 3.x compatible version of this module, please see the [1.0 branch, or 1.x release line](https://github.com/silverstripe/silverstripe-restfulserver/tree/1.0#readme).
|
||||
|
||||
## Configuration
|
||||
|
||||
Example DataObject with simple API access, giving full access to all object properties and relations,
|
||||
|
|
Loading…
Reference in New Issue