Skip to content

docs: add baseURL for accessing endpoints #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
luqmanoop wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add baseURL for accessing endpoints #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down Expand Up @@ -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)
- Jane C. Anaekwe - [@JCanaks](https://github.com/JCanaks)