Skip to content

Commit

Permalink
Merge pull request #108 from creative-commoners/pulls/3.0/cms5-readme
Browse files Browse the repository at this point in the history
DOC Update README.md for CMS 5
  • Loading branch information
sabina-talipova authored Apr 24, 2023
2 parents 6267b06 + 39614ba commit f110752
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@
[![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`
on the appropriate DataObjects. You will need to ensure that all of your data manipulation and security is defined in
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,
Expand Down

0 comments on commit f110752

Please sign in to comment.