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

Corrected some mistakes in README.md

Browse Source
This commit is contained in:
Kayne Ruse
2021-01-30 11:56:17 +11:00
parent 9b8ef8f2e7
commit adb91947d7
1 changed files with 19 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+19 -15
View File
@@ -2,19 +2,23 @@
An API centric news server. Uses Sequelize and mariaDB by default. An API centric news server. Uses Sequelize and mariaDB by default.
# Setup
Run the SQL script `sql/create_database.sql`. This will set up an empty database called `news`, and a new user called `news`.
# API # API
``` ```
//NOTE: you can add a "limit" query parameter to change the default limit //NOTE: you can add a "limit" query parameter to change the default limit
/news?limit=10 GET /news?limit=10
//GET get latest news, up to a default limit, or specify the index "id" //get latest news, up to a default limit, or specify the index "id"
/news/:id GET /news/:id
//GET get the news starting from the beginning, up to a default limit, or specify the index "id" //get the news starting from the beginning, up to a default limit, or specify the index "id"
/news/archive/:id GET /news/archive/:id
//result: //result (if only a single article is specified, returns just that article rather than an array):
[ [
{ {
"index": index, //absolute index of the result "index": index, //absolute index of the result
@@ -26,13 +30,13 @@ An API centric news server. Uses Sequelize and mariaDB by default.
... ...
] ]
//GET get the latest titles, up to a default limit, or specify the index "id" //get the latest titles, up to a default limit, or specify the index "id"
/news/titles/:id GET /news/titles/:id
//GET get the titles starting from the beginning, up to a default limit, or specify the index "id" //get the titles starting from the beginning, up to a default limit, or specify the index "id"
/news/archive/titles/:id GET /news/archive/titles/:id
//result: //result (if only a single article is specified, returns just that article rather than an array):
[ [
{ {
"index": index, //absolute index of the result "index": index, //absolute index of the result
@@ -42,8 +46,8 @@ An API centric news server. Uses Sequelize and mariaDB by default.
... ...
] ]
//POST send a formatted JSON object, returns new index on success, or error on failure //send a formatted JSON object, returns new index on success, or error on failure
/news/publish POST /news
//arguments: //arguments:
{ {
@@ -60,8 +64,8 @@ An API centric news server. Uses Sequelize and mariaDB by default.
"error": error //error encountered, or undefined "error": error //error encountered, or undefined
} }
//PATCH similar to `/news/publish`, but allows overwriting an existing post //similar to `/news/publish`, but allows overwriting an existing post
/news/edit/:id PATCH /news/:id
//arguments: //arguments:
{ {