mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-01-06 22:40:14 -05:00
parent
6163d1f128
commit
efc5219afa
3 changed files with 30 additions and 0 deletions
28
core/server/api/README.md
Normal file
28
core/server/api/README.md
Normal 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...
|
1
core/server/api/shared/index.js
Normal file
1
core/server/api/shared/index.js
Normal file
|
@ -0,0 +1 @@
|
|||
module.exports = {};
|
1
core/server/api/v2/index.js
Normal file
1
core/server/api/v2/index.js
Normal file
|
@ -0,0 +1 @@
|
|||
module.exports = {};
|
Loading…
Reference in a new issue