-
-
Notifications
You must be signed in to change notification settings - Fork 10.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added empty api v2 + shared folder and README.md (#9920)
refs #9866
- Loading branch information
1 parent
6163d1f
commit efc5219
Showing
3 changed files
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
module.exports = {}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
module.exports = {}; |
efc5219
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
😍 this!