tonyair/silverstripe-restfulserver
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-restfulserver synced 2024-10-22 14:05:58 +02:00
Code Issues Projects Releases Wiki Activity

DOC Update README.md for CMS 5

Browse Source
This commit is contained in:
Guy Sartorelli 2023-04-19 16:25:38 +12:00
parent 6267b0654e
commit 39614ba6e1
No known key found for this signature in database
GPG Key ID: F313E3B9504D496A
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -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,