tonyair
/
silverstripe-restfulserver
mirror of https://github.com/silverstripe/silverstripe-restfulserver
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #108 from creative-commoners/pulls/3.0/cms5-readme 

DOC Update README.md for CMS 5
This commit is contained in:
Sabina Talipova 2023-04-24 13:42:08 +12:00 committed by GitHub
parent 6267b0654e 39614ba6e1
commit f110752973
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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) [![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/) [![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 ## Overview
This class gives your application a RESTful API. All you have to do is set the `api_access` configuration option to `true` 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 your model layer (ie, the DataObject classes) and not in your Controllers. This is the recommended design for SilverStripe
applications. 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 ## Configuration
Example DataObject with simple API access, giving full access to all object properties and relations, Example DataObject with simple API access, giving full access to all object properties and relations,