krgamestudios/news-server
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated documentation

Browse Source
This commit is contained in:
Kayne Ruse
2021-08-21 22:45:01 +01:00
parent fd1ba06b45
commit db61357a0f
1 changed files with 45 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+45 -16
View File
@@ -6,10 +6,10 @@ An API centric news server. Uses Sequelize and mariaDB by default.
There are multiple ways to run this app - it can run on it's own via `npm start` (for production) or `npm run dev` (for development). it can also run inside docker using `docker-compose up --build` - run `node configure-script.js` to generate docker-compose.yml and startup.sql.
To generate an authorization token, use [auth-server](https://github.com/krgamestudios/auth-server). A public-facing development auth-server is available here (tokens are 10 minutes):
To generate an authorization token, use [auth-server](https://github.com/krgamestudios/auth-server). A public-facing development auth-server is available here (tokens are valid for 10 minutes):
```
POST https://dev-auth.eggtrainer.com/auth/login HTTP/1.1
POST https://dev-auth.krgamestudios.com/auth/login HTTP/1.1
Content-Type: application/json
{
@@ -25,13 +25,21 @@ Content-Type: application/json
//NOTE: you can add a "limit" query parameter to change the default limit
GET /news?limit=10
//get latest news, up to a default limit, or specify the index "id"
###
//DOCS: get latest news, up to a default limit, or specify the index "id"
GET /news/:id
//get the news starting from the beginning, up to a default limit, or specify the index "id"
###
//DOCS: get the news starting from the beginning, up to a default limit, or specify the index "id"
GET /news/archive/:id
//result (if only a single article is specified, returns just that article rather than an array):
//DOCS: result (if only a single article is specified, returns just that article rather than an array):
[
{
"index": index, //absolute index of the result
@@ -45,13 +53,21 @@ GET /news/archive/:id
...
]
//get the latest metadata, up to a default limit, or specify the index "id"
###
//DOCS: get the latest metadata, up to a default limit, or specify the index "id"
GET /news/metadata/:id
//get the metadata starting from the beginning, up to a default limit, or specify the index "id"
###
//DOCS: get the metadata starting from the beginning, up to a default limit, or specify the index "id"
GET /news/archive/metadata/:id
//result (if only a single article is specified, returns just that article rather than an array):
//DOCS: result (if only a single article is specified, returns just that article rather than an array):
[
{
"index": index, //absolute index of the result
@@ -64,38 +80,51 @@ GET /news/archive/metadata/:id
...
]
//send a formatted JSON object, returns new index on success, or error on failure
###
//DOCS: send a formatted JSON object, returns new index on success, or error on failure
POST /news
Authorization: Bearer XXX
//arguments:
{
"title": title //title of the article
"author": author //author of the article
"body": body //body of the article
}
//result (status 200 on success, otherwise an error status):
//DOCS: result (status 200 on success, otherwise an error status):
{
"index": index //new index of the article
}
//similar to `POST /news`, but allows overwriting an existing article
###
//DOCS: similar to `POST /news`, but allows overwriting an existing article
PATCH /news/:id
Authorization: Bearer XXX
//arguments:
{
"title": title //title of the article, optional
"author": author //author of the article, optional
"body": body //body of the article, optional
}
result: status 200 on success, otherwise an error status
//DOCS: result: status 200 on success, otherwise an error status
//remove an article from the news feed
###
//DOCS: remove an article from the news feed
DELETE /news/:id
Authorization: Bearer XXX
//result: status 200 on success, otherwise an error status
//DOCS: result: status 200 on success, otherwise an error status
###
```