Added a few missing pieces of info to the README

This commit is contained in:
Gregory Campbell
2021-11-26 11:26:28 -05:00
parent 149a25c251
commit af77005291
+14 -5
View File
@@ -32,10 +32,9 @@ time: {type:Date, required:true}`
<p>Clone this repository and install dependencies</p> <p>Clone this repository and install dependencies</p>
`> git clone git@github.com:gjcampbell777/RESTapi_demo.git > git clone git@github.com:gjcampbell777/RESTapi_demo.git
> cd express-rest-api > cd express-rest-api
> npm install
> npm install`
### Deploy ### Deploy
@@ -65,6 +64,9 @@ time: {type:Date, required:true}`
## REST API Documentation ## REST API Documentation
<p>All of the calls below can be done using services like Postman or through curl commands with <br>
the URL https://gregs-rest-api-demo.herokuapp.com.</p>
### GET ### GET
<p>To get info on all messages use</p> <p>To get info on all messages use</p>
@@ -83,7 +85,7 @@ time: {type:Date, required:true}`
`/msg/:id` `/msg/:id`
<p>The id info is taken from the parameter, the message info is taken from the body<br> <p>The id info is taken from the parameter, the message info is taken from a json body containing a message key<br>
and the timestamp is taken from the API logic</p> and the timestamp is taken from the API logic</p>
### PUT ### PUT
@@ -92,7 +94,7 @@ and the timestamp is taken from the API logic</p>
`/msg/:id` `/msg/:id`
<p>The id info is taken from the parameter and the new message info is taken from the body</p> <p>The id info is taken from the parameter and the new message info is taken from a json body containing a message key</p>
### DELETE ### DELETE
@@ -106,5 +108,12 @@ and the timestamp is taken from the API logic</p>
<p>The id info is taken from the parameter</p> <p>The id info is taken from the parameter</p>
<br><p>Example of desired inputs: <br>
URL: `https://gregs-rest-api-demo.herokuapp.com/msg/5` body: `{"message":"test"}`</p>
## Server Logs
<p>Server logs can be found using the HEroku CLI command `heroku logs` within the repo once the web app is deployed</p>
## Licence ## Licence
MIT MIT