Skip to content

Commit a2b164a

Browse files
authored
Create README.md
1 parent af76603 commit a2b164a

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# HttpStatusCodeAPI
2+
Description: A simple API endpoint for response http status codes
3+
4+
## How to use?
5+
1. Clones repo and run
6+
```go
7+
go run main.go
8+
```
9+
If you don't have GO, go [here](https://golang.org/) for instructions of installation<br/>
10+
Access the endpoint at ***localhost:8080/status/[code number]***<br/>
11+
Eg: localhost:8080/status/404 <br/>
12+
=> This will return a document with **404** status<br/>
13+
2. Opens executable file by double-clicking a file inside **executables** folder that is compatible with your system.
14+
3. Accesses API through already hosted link, please follow the format below:<br/>
15+
**https://arcane-basin-93470.herokuapp.com/status/[_code number_]**<br/>
16+
Eg: https://arcane-basin-93470.herokuapp.com/status/200 <br/>
17+
=> This will return a document with **200** status<br/>
18+
19+
Note: This API has all the status codes that you can get back from GET request, 2xx - 5xx

0 commit comments

Comments
 (0)