0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-01-06 22:40:14 -05:00

Added empty api v2 + shared folder and README.md (#9920)

refs #9866
This commit is contained in:
Katharina Irrgang 2018-09-27 20:33:21 +02:00 committed by Rishabh Garg
parent 6163d1f128
commit efc5219afa
3 changed files with 30 additions and 0 deletions

28
core/server/api/README.md Normal file
View file

@ -0,0 +1,28 @@
# API Versioning
Ghost supports multiple API versions.
Each version lives in a separate folder e.g. api/v0.1, api/v2.
Next to the API folders there is a shared folder, which the API versions use.
**NOTE: v0.1 is deprecated and we won't touch this folder at all. The v0.1 folder
contains the API layer which we have used since Ghost was born.**
## Stages
Each request goes through the following stages:
- validation
- input serialisation
- permissions
- query
- output serialisation
The framework we are building pipes a request through these stages depending on the API controller implementation.
## API Controller
A controller is no longer just a function, it's a set of configurations.
More is coming soon...

View file

@ -0,0 +1 @@
module.exports = {};

View file

@ -0,0 +1 @@
module.exports = {};