Skip to content

Latest commit

 

History

History
66 lines (61 loc) · 3.64 KB

README.md

File metadata and controls

66 lines (61 loc) · 3.64 KB
Raw

BookServer-Api-Golang

This API server provides endpoints to create,read,update & delete users and Books.

Data Model Json

  • User Model:
{
    "firstName": "Mridul",
    "lastName": "Halder",
    "userName": "mridul12",
    "password": "123"
}
  • Book Model:
{
    "uuid": 11,
    "name": "learn-api",
    "author": "Anisur",
    "publishDate": "01-02-2022",
    "ISBN": "0999-0555-5954"
}

To Start API Server Locally

$ git clone https://github.com/anisurrahman75/bookserver-api-mysql.git

$ make compose-build; make compose-start

$ ./apiDesign startServer -a=false

Note: Default Port: 3030 && Authentication: JWT

Custom Port && Without Authentication

$ ./apiDesign startServer -p=<your_port> #Your custom port  
$ ./apiDesign startServer -a=false # Run server without authentication

To Start API Server using Docker

$ docker pull anisurrahman75/book-server-api:v1.4
$ docker run  -p 3030:3030 anisurrahman75/book-server-api:v1.4 # without auth

Available API EndPoints

Method API EndPoint Authentication Type PayLoad Description Curl Command
GET /api No-Auth Not-Required Welcome page of this Book-Server $ curl -X GET http://localhost:3030/api
POST /api/registerUser No-Auth Json File: User Model Register a new User $ curl -X POST -H "Content-Type:application/json" -d '<userModelJson>' http://localhost:3030/api/registerUser
POST /api/logIn Basic-Auth Not-Required LogIn with registered user,pass and get bearer token $ curl -X POST --user '<userName>:<passWord>' localhost:3030/api/logIn
GET /api/books Bearer Token Required Not-Required Get all BooksList frrom database in response $ curl -X GET -H "Authorization: Bearer <bearerToken>" http://localhost:3030/api/books
POST /api/books Bearer Token Required Json File: Book Model Add new book and return added bookDetails in response $ curl -X POST -H "Authorization: Bearer <bearerToken>" -H "Content-Type:application/json" -d '<bookModelJson>' localhost:3030/api/books
GET /api/books/{bookId} Bearer Token Required Not-Required Search book with bookId and get bookDetails in response $ curl -X GET -H "Authorization: Bearer <bearerToken>" localhost:3030/api/books/<bookId>
PUT /api/books/{bookId} Bearer Token Required Json File: Book Model Update book and return updated bookDetails in response $ curl -X PUT -H "Authorization: Bearer <bearerToken>" -H "Content-Type:application/json" -d '<bookModelJson>' localhost:3030/api/books/<bookId>
DELETE /api/books/{bookId} Bearer Token Required Not-Required Delete a aook and return deleted bookDetails in response $ curl -X DELETE -H "Authorization: Bearer <bearerToken>" localhost:3030/api/books/<bookId>

Resources