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

minmod: notice.api:3.0

This commit is contained in:
xdrm-brackets 2017-12-12 23:28:06 +01:00
parent ae41ff9a5e
commit 7195409793
1 changed files with 0 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
notice/api/3.0.md
View File

@ -43,8 +43,6 @@ Plan
# **I.** Overview # **I.** Overview
----
## **1** Introduction & features ## **1** Introduction & features
The `api` package (v3.0) allows you to easily create and manage an API for your applications. It can be used as an HTTP API (REST, or other kind), and you can use it as an internal core for your system. The `api` package (v3.0) allows you to easily create and manage an API for your applications. It can be used as an HTTP API (REST, or other kind), and you can use it as an internal core for your system.
@ -87,8 +85,6 @@ So each of your functionalities must have a dedicated `HTTP method` and a corres
# **II.** Usage # **II.** Usage
----
## **1** REST API ## **1** REST API
In order for the API to catch **URI**, you must use a router. It will allow the API to get the requested URI. In order for the API to catch **URI**, you must use a router. It will allow the API to get the requested URI.
@ -151,8 +147,6 @@ $specific_response_field = $response->get('specific_field_name');
# **III.** Configuration # **III.** Configuration
----
The documentation consists of a _chain_ of urls each one containing no or several HTTP method specifications. The documentation consists of a _chain_ of urls each one containing no or several HTTP method specifications.
@ -277,8 +271,6 @@ If the API is called with HTTP directly, it will not print the **json** response
# **IV.** Implementation # **IV.** Implementation
----
## **1** - permissions : AuthSystem ## **1** - permissions : AuthSystem
In order to implement your _Authentification System_ you have to implement the **interface** `AuthSystem` located in `/build/api/core/AuthSystem`. In order to implement your _Authentification System_ you have to implement the **interface** `AuthSystem` located in `/build/api/core/AuthSystem`.