https://github.com/shiponcs/golang-rest-api-server
A REST API Server written in Golang serves a Book Store
https://github.com/shiponcs/golang-rest-api-server
cobra-cli dotenv go-chi golang http json
Last synced: about 1 month ago
JSON representation
A REST API Server written in Golang serves a Book Store
- Host: GitHub
- URL: https://github.com/shiponcs/golang-rest-api-server
- Owner: shiponcs
- License: other
- Created: 2024-12-18T16:00:33.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-17T12:56:28.000Z (4 months ago)
- Last Synced: 2025-02-14T19:51:57.097Z (3 months ago)
- Topics: cobra-cli, dotenv, go-chi, golang, http, json
- Language: Go
- Homepage:
- Size: 23.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# A REST API Server in Golang
## Dependecies
- [go](https://github.com/golang)
- [spf13/cobra](https://github.com/spf13/cobra),
- [go-chi/chi](https://github.com/go-chi/chi),
- [golang-jwt/jwt](https://github.com/golang-jwt/jwt)
## Build and Run the project
```bash
> make all
mkdir -p bin
go build -o bin/book-store-api-server
```
```bash
❯ bin/book-store-api-server serve --port 8080 main ✱ ◼
serving at port 8080
```
## API Endpoints
- POST /authorize
- Implements Basic Auth
```bash
❯ curl -X POST --user admin:admin localhost:8080/authorize
token eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MzQ1NTA4ODQsIm5hbWUiOiJhZG1pbiJ9.7eyf8XmnZHgG0CNUQXJqjy4m8cvGITCkdUg2eFJ1CLo
```
- GET /books
```bash
❯ curl -X GET -H "Authorization: Bearer " localhost:8080/books
[{"author":"The MANIAC","category":"Novel","id":0,"isbn":"9780593654491","title":"Benjamín Labatut"},{"author":"George Orwell","category":"Dystopian","id":1,"isbn":"9780451524935","title":"1984"},{"author":"J.K. Rowling","category":"Fantasy","id":2,"isbn":"9780439708180","title":"Harry Potter and the Sorcerer's Stone"},{"author":"Yuval Noah Harari","category":"Non-Fiction","id":3,"isbn":"9780062316097","title":"Sapiens: A Brief History of Humankind"},{"author":"Michelle Obama","category":"Biography","id":4,"isbn":"9781524763138","title":"Becoming"}]
```
- GET /book/{id}
```bash
❯ curl -X GET -H "Authorization: Bearer localhost:8080/book/2
{"author":"J.K. Rowling","category":"Fantasy","id":2,"isbn":"9780439708180","title":"Harry Potter and the Sorcerer's Stone"}
```
- DELETE /book/{id}
```bash
❯ curl -X DELETE -H "Authorization: Bearer localhost:8080/book/1
Deleted
```
- PUT /book/{id}
```bash
❯ curl -X PUT -H "Content-Type: application/json" \
-H "Authorization: Bearer " \
-d '{
"author": "J.K. Rowling",
"title": "Harry Potter and the Chamber of Secrets",
"category": "Fantasy",
"isbn": "9780439064873"
}'\
http://localhost:8080/book/3
{ "author":"","category":"Fantasy","id":3,"isbn":"9780439064873","title":"Harry Potter and the Chamber of Secrets"}
```
## Clean
```bash
> make clean
rm -rf bin
```
## Docker
### Build Docker Image
```bash
> make docker-build
```
### Run Docker Image
#### Run with default options
```bash
> docker run -p 8080:8080 book-store-api-server
serving at port 8080
```
Default port is 8080 and other default values can be found at .env file.
#### Pass Command Line Arg values
##### Modify the listening port
```bash
> docker run -p 8081:8081 book-store-api-server --port 8081
serving at port 8081
```
#### Modify environment values
##### Modify the password
```bash
❯ docker run -p 8080:8080 --env PASSWORD=admin book-store-api-server
serving at port 8080
```
##### Override the .env file
###### Mount the new .env file
```bash
❯ docker run -p 8080:8080 -v $(pwd)/.env:/app/.env book-store-api-server
serving at port 8080
```
### Run in Kubernetes
```bash
> kubectl create ns book-server
> kubectl apply -f k8s/manifests/deployment.yaml -n book-server
```