You will need to have NodeJS installed in order to set this up. This can be found on nodejs.org.
Once you have NodeJS, you will need to install Express in the application directory. Instructions can be found on expressjs.com.
The fields: article, title, tags, and description are all text fields. Their content does not matter to, and is not checked by, the publishing microservise.
The id field is a 24 character long lowercase hex string. It is stored as a text field.
request: A POST request to /save_article
input: The request body should contain a JSON object with the data from the editor. It should atleast contain the fields: article, title, tags, description.
Effect: It should request authentication from the user if authentication is on. If authentication is successful or turned off then, the supplied article should be inserted into the article database, and it should attempt to update the indexer.
Success condition: If authentication was successful or turned off. If the article was inserted into the database.
return: If the request was successful: An Http response with status code 204.
If the request was unsuccessful: An Http response with status code 500.
If the authentication was unsuccessful: An Http response with status code 401.
request: A GET request to /list
Effect: None.
Success condition: If a list of the articles in the database was generated and returned.
return: If the request was successful: A JSON object containing a field "list" that is a list with JSON objects, each should have the fields: title, description, id.
If the request was unsuccessful: An Http response with status code 500.
request: A GET request to /article/id
input: None.
Effect: None.
Success condition: If the article was found, turn into a valid html file, and returned.
return: If the request was successful: An html page with the article.
If the request was unsuccessful: An Http response with status code 500.
request: A GET request to /article_json/id
input: None.
Effect: None.
Success condition: If the article JSON object was found and returned.
return: If the request was successful: A JSON object with the fields: title, description, article, tags.
If the request was unsuccessful: An Http response with status code 500.
request: A DELETE request to /article_json/id
input: None.
Effect: It should request authentication from the user if authentication is on. If authentication is successful or turned off then, the requested article should be deleted from the article database, and it should attempt to update the indexer.
Success condition: If authentication was successful or turned off. If the article was deleted from the database.
return: If the request was successful: An Http response with status code 204.
If the request was unsuccessful: An Http response with status code 500.
If the authentication was unsuccessful: An Http response with status code 401.