xdrm-brackets
/
xdrm-framework
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update api:2.2 notice #2

This commit is contained in:
xdrm-brackets 2017-09-10 18:39:06 +02:00
parent f09be885a6
commit 3ee1669cdb
1 changed files with 10 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
notice/api/2.2.md
View File

@ -9,30 +9,30 @@ requires:
Links Links
==== ====
[**I.** Overview](#I.-overview) [**I.** Overview](#i-overview)
- [**1** Introduction & features](#1-introduction--features) - [**1** Introduction & features](#1-introduction--features)
- [**2** Basic knowledge](#2-basic-knowledge) - [**2** Basic knowledge](#2-basic-knowledge)
[**II.** Usage](#2---usage) [**II.** Usage](#ii-usage)
- [**1** Setup](#1-setup) - [**1** Setup](#1-setup)
- [**2** Php requirements](#2-php-requirements) - [**2** Php requirements](#2-php-requirements)
- [**3** From php internally](#3-from-php-internally) - [**3** From php internally](#3-from-php-internally)
- [**4** From HTTP requests](#4-from-http-requests) - [**4** From HTTP requests](#4-from-http-requests)
[**III.** Configuration](#3---configuration) [**III.** Configuration](#iii-configuration)
- [**1** Basic usage](#1-basic-usage) - [**1** Basic usage](#1-basic-usage)
- [**2** Advanced usage](#2-advanced-usage) - [**2** Advanced usage](#2-advanced-usage)
[**IV.** Implementation](#4---implementation) [**IV.** Implementation](#iv-implementation)
- [**1** Permissions : AuthSystem](#1-permissions--authsystem) - [**1** Permissions : AuthSystem](#1-permissions--authsystem)
- [**2** Modules & methods](#2-modules--methods) - [**2** Modules & methods](#2-modules--methods)
- [**3** Automatic type check](#3-automatic-type-check) - [**3** Automatic type check](#3-automatic-type-check)
[**V.** Class documentation](#5---class-documentation) [**V.** Class documentation](#v-class-documentation)
- [**1** Request](#1-request) - [**1** Request](#1-request)
- [**2** Response](#2-response) - [**2** Response](#2-response)
@ -86,8 +86,8 @@ If you want to delete the article of id `52`, you must request `article/delete`
[2] - Usage > # **II.** Usage
====
> ## **1** Setup > ## **1** Setup
In order to make the API work, you have to : In order to make the API work, you have to :
1. Edit the configuration file according to your needs (cf. [configuration](#3---configuration)) 1. Edit the configuration file according to your needs (cf. [configuration](#3---configuration))
@ -232,8 +232,7 @@ Then can handle various kinds of URL :
[3] - Configuration > # **III.** Configuration
====
```json ```json
{ {
@ -280,8 +279,7 @@ _*_ If you want URL (GET) parameters, the {param_name} must be `URL_0`, `URL_1`
[4] - Implementation > # **IV.** Implementation
====
> ## **1** Permissions : AuthSystem > ## **1** Permissions : AuthSystem
@ -319,8 +317,7 @@ If you don't return the 'error' field, by default it is set to `new Error(Err::S
[5] - Class documentation > # **V.** Class documentation
====
> ## **4** Checker > ## **4** Checker