diff --git a/README.md b/README.md index 1137aac..855f130 100644 --- a/README.md +++ b/README.md @@ -32,10 +32,9 @@ time: {type:Date, required:true}`
Clone this repository and install dependencies
-`> git clone git@github.com:gjcampbell777/RESTapi_demo.git +> git clone git@github.com:gjcampbell777/RESTapi_demo.git > cd express-rest-api - -> npm install` +> npm install ### Deploy @@ -65,6 +64,9 @@ time: {type:Date, required:true}` ## REST API Documentation +All of the calls below can be done using services like Postman or through curl commands with
+the URL https://gregs-rest-api-demo.herokuapp.com.
To get info on all messages use
@@ -83,7 +85,7 @@ time: {type:Date, required:true}` `/msg/:id` -The id info is taken from the parameter, the message info is taken from the body
+
The id info is taken from the parameter, the message info is taken from a json body containing a message key
and the timestamp is taken from the API logic
The id info is taken from the parameter and the new message info is taken from the body
+The id info is taken from the parameter and the new message info is taken from a json body containing a message key
### DELETE @@ -106,5 +108,12 @@ and the timestamp is taken from the API logicThe id info is taken from the parameter
+Example of desired inputs:
+URL: `https://gregs-rest-api-demo.herokuapp.com/msg/5` body: `{"message":"test"}`
Server logs can be found using the HEroku CLI command `heroku logs` within the repo once the web app is deployed
+ ## Licence MIT \ No newline at end of file