From 3c752b1a12fb7529b94339156c224f809405220a Mon Sep 17 00:00:00 2001 From: Luqman Olushi Date: Tue, 10 Sep 2019 08:38:07 +0100 Subject: [PATCH] docs: add baseURL for accessing endpoints --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e3bd2dd..d3e8b79 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,14 @@ npm test ``` ### API Features/Endpoints The following are the API features and endpoints for the application which can be tested via [Postman](https://www.getpostman.com/) or any other API testing tool. + +#### BASE_URL +All API endpoints can be accessed using baseURL + +- https://randomdial.herokuapp.com/api (remote) + +- http://localhost:3000/api (local) + #### Generate Random 10-digits phone numbers `POST /phonenumbers` - Generates a single or multiple phone numbers (The amount to be generated should be specified in the request body). @@ -159,4 +167,4 @@ Descending order Click [here](https://documenter.getpostman.com/view/5131256/SVfKyWPA?version=latest) to view the API documentation generated for this application with [Postman](https://www.getpostman.com/). ### Author -- Jane C. Anaekwe - [@JCanaks](https://github.com/JCanaks) \ No newline at end of file +- Jane C. Anaekwe - [@JCanaks](https://github.com/JCanaks)