{"swagger":"2.0","info":{"description":"RESTful API of Nowhere book store","version":"1.0.0","title":"a Book API","contact":{"email":"pichet.suesat@gmail.com"}},"schemes":["https"],"tags":[{"name":"book","description":"all of /book"},{"name":"cart","description":"all of /cart"},{"name":"order","description":"all of /order"},{"name":"user","description":"all of /user"},{"name":"payment","description":"all of /payment"},{"name":"shipping","description":"all of /shipping"}],"paths":{"/book":{"get":{"tags":["book"],"summary":"get all books in store.","description":"Get all book in store, you can filter book for some condition and search some book what you want.\n","produces":["application/json"],"parameters":[{"in":"query","name":"limit","description":"maximum number of records to return","type":"integer","format":"int32","minimum":0,"maximum":50},{"in":"query","name":"offset","description":"number of records to skip for pagination","type":"integer","format":"int32","minimum":0},{"in":"query","name":"order","description":"condition for get book in database","type":"string","enum":["topsellers","recommeneded"]},{"in":"query","name":"name","description":"search book by book_name","type":"string"}],"responses":{"200":{"description":"search results matching criteria","schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/definitions/BookItem"}}}}},"400":{"description":"bad input parameter","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false}}}}}},"post":{"tags":["book"],"summary":"create new book","description":"Add new book to store.","consumes":["application/json"],"produces":["application/json"],"security":[{"Bearer":[]}],"parameters":[{"in":"body","name":"book","description":"book detail to add","schema":{"$ref":"#/definitions/AddBookItem"}}],"responses":{"201":{"description":"item created","schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string","example":"inserted"},"data":{"$ref":"#/definitions/BookItem"}}}},"400":{"description":"invalid input, object invalid","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"${input} not valid"}}}}}}},"/book/:bookId":{"get":{"tags":["book"],"summary":"get a books in store.","description":"Get a book in store, from bookId.\n","produces":["application/json"],"responses":{"200":{"description":"search results matching criteria","schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string","example":"found a book"},"data":{"$ref":"#/definitions/BookItem"}}}},"404":{"description":"book not found","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"book not found"}}}}}},"put":{"tags":["book"],"summary":"update a books in store.","description":"Update a book in store, from bookId.\n","consumes":["application/json"],"produces":["application/json"],"security":[{"Bearer":[]}],"parameters":[{"in":"body","name":"book","description":"book detail to add","schema":{"$ref":"#/definitions/AddBookItem"}}],"responses":{"200":{"description":"item created","schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string","example":"updated"},"data":{"$ref":"#/definitions/BookItem"}}}},"400":{"description":"invalid input, object invalid","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"${input} not valid"}}}},"403":{"description":"only book's onwer can update a book.","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"only owner can update this book"}}}},"404":{"description":"book not found.","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"book not found"}}}}}},"delete":{"tags":["book"],"summary":"delete a books in store.","description":"Delete a book in store, from bookId (soft-delete, only owner can delete).","consumes":["application/json"],"produces":["application/json"],"security":[{"Bearer":[]}],"responses":{"204":{"description":"item deleted","schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string","example":"deleted!"}}}},"403":{"description":"only book's onwer can delete a book.","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"only owner can delete this book"}}}},"404":{"description":"book not found.","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"book not found"}}}}}}},"/book/:bookId/rating":{"post":{"tags":["book"],"summary":"increase rating of book","description":"increase rating of book, insert score 1-5","consumes":["application/json"],"produces":["application/json"],"security":[{"Bearer":[]}],"parameters":[{"in":"body","name":"body","description":"score what you want to increase this book (1-5)","schema":{"type":"object","properties":{"ratingScore":{"type":"integer","example":5}}}}],"responses":{"200":{"description":"book's rating increased","schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string","example":"increased!"}}}},"400":{"description":"input invalid","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"${input} invalid"}}}},"403":{"description":"book's onwer can't vote this itself's book.","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"owner can't vote itself's book."}}}},"404":{"description":"book not found.","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"book not found"}}}}}}},"/cart":{"get":{"tags":["cart"],"summary":"get all books in cart.","description":"Get all book in cart.","produces":["application/json"],"security":[{"Bearer":[]}],"responses":{"200":{"description":"lists all book in cart.","schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"book":{"type":"array","items":{"$ref":"#/definitions/BookInCartItem"}},"summary":{"type":"object","properties":{"price":{"type":"number","example":4000.0}}}}}}}},"204":{"description":"no book in cart","schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object"}}}}}},"post":{"tags":["cart"],"summary":"add some book to cart","description":"add some book to cart, send bookId and quantity","consumes":["application/json"],"produces":["application/json"],"security":[{"Bearer":[]}],"parameters":[{"in":"body","name":"body","description":"score what you want to increase this book (1-5)","schema":{"type":"object","properties":{"book_id":{"type":"integer","example":5},"quantity":{"type":"integer","example":1}}}}],"responses":{"200":{"description":"added a book to cart.","schema":{"type":"object","properties":{"success":{"type":"boolean","example":true},"message":{"type":"string","example":"added to cart!"}}}},"400":{"description":"input invalid","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"${input} invalid"}}}}}}},"/cart/:bookId":{"delete":{"tags":["cart"],"summary":"delete some item in cart.","description":"Delete some item in cart.","consumes":["application/json"],"produces":["application/json"],"security":[{"Bearer":[]}],"responses":{"204":{"description":"some item in cart deleted","schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string","example":"deleted a book in cart!"}}}},"404":{"description":"book not found.","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"this book was deleted / not found"}}}}}}},"/user":{"get":{"tags":["user"],"summary":"get user information","description":"Get user's information","produces":["application/json"],"security":[{"Bearer":[]}],"responses":{"200":{"description":"user information","schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/definitions/UserItem"}}}},"401":{"description":"Unauthorized","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"Unauthorized"}}}},"403":{"description":"No token provide","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"No token provided!"}}}}}}},"/user/login":{"post":{"tags":["user"],"summary":"login account","description":"login account","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"login","schema":{"$ref":"#/definitions/LoginItem"}}],"responses":{"200":{"description":"login succeed and return JWT token","schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string","example":"login succeed"},"token":{"type":"string","example":"${JWT_encoded}"}}}},"400":{"description":"invalid input","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"${input} not valid"}}}},"401":{"description":"email/password invalid or account not found","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","enum":["password invalid","account not found"]}}}}}}},"/user/register":{"post":{"tags":["user"],"summary":"create new account","description":"create new account","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"register","schema":{"$ref":"#/definitions/RegisterItem"}}],"responses":{"200":{"description":"registed succeed","schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string","example":"registered succeed"}}}},"400":{"description":"invalid input","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"input not valid"},"data":{"type":"array","items":{"$ref":"#/definitions/RegisterValidationItem"}}}}}}}},"/user/address":{"get":{"tags":["user"],"summary":"get all user's address","description":"get all user's address","consumes":["application/json"],"produces":["application/json"],"security":[{"Bearer":[]}],"responses":{"200":{"description":"registed succeed","schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/definitions/UserAddressItem"}}}}}}},"post":{"tags":["user"],"summary":"add new user's address","description":"add new user's address","consumes":["application/json"],"produces":["application/json"],"security":[{"Bearer":[]}],"parameters":[{"in":"body","name":"address","schema":{"$ref":"#/definitions/AddUserAddressItem"}}],"responses":{"200":{"description":"added new user's address","schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string","example":"inserted!"},"data":{"$ref":"#/definitions/UserAddressItem"}}}},"400":{"description":"invalid input","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","example":"input not valid"},"data":{"type":"array","items":{"$ref":"#/definitions/AddressValidationItem"}}}}}}}},"/order":{"get":{"tags":["order"],"summary":"Preview order detail before create order","description":"Preview order detail before create order","consumes":["application/json"],"produces":["application/json"],"security":[{"Bearer":[]}],"responses":{"200":{"description":"preview succeed","schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/definitions/OrderItem"}}}}}},"post":{"tags":["order"],"summary":"Create new order","description":"Create new order from tmp to master, if not send \"shipping_id\", \"payment_id\" and \"address_id\", program was used default value of this.","consumes":["application/json"],"produces":["application/json"],"security":[{"Bearer":[]}],"parameters":[{"in":"body","name":"order","schema":{"type":"object","properties":{"address_id":{"type":"number","example":4},"payment_id":{"type":"number","example":1},"shipping_id":{"type":"number","example":1}}}}],"responses":{"200":{"description":"created new order","schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string","example":"create order succeed, please payment."},"id":{"type":"number","example":35}}}},"500":{"description":"can't created order because no book in cart.","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"message":{"type":"string","enum":["cart is empty","no user address","no shipping information","no payment information"]},"id":{"type":"number","example":0}}}}}}},"/order/:orderId":{"get":{"tags":["order"],"summary":"Get a order detail","description":"Get a order detail","consumes":["application/json"],"produces":["application/json"],"security":[{"Bearer":[]}],"responses":{"200":{"description":"succeed","schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"order":{"$ref":"#/definitions/OrderMasterDetailItem"},"book":{"type":"array","items":{"$ref":"#/definitions/OrderMasterBookItem"}}}}}}},"404":{"description":"order not found","schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"object"}}}}}}},"/payment":{"get":{"tags":["payment"],"summary":"get all payment method is avaliable in store","description":"get all payment method is avaliable in store\n","produces":["application/json"],"responses":{"200":{"description":"list all payment method in store","schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/definitions/PaymentItem"}}}}}}}},"/shipping":{"get":{"tags":["shipping"],"summary":"get all shipping method is avaliable in store","description":"get all shipping method is avaliable in store\n","produces":["application/json"],"responses":{"200":{"description":"list all shipping method in store","schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/definitions/ShippingItem"}}}}}}}}},"definitions":{"BookItem":{"type":"object","properties":{"id":{"type":"string","format":"int32","example":1},"isbn":{"type":"string","example":9783161484100},"name":{"type":"string","example":"ASP.NET Core v.6"},"description":{"type":"string","example":"It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout..."},"price":{"type":"number","example":"400.00"},"rating_value":{"type":"integer","example":"4.5"},"total_rating":{"type":"integer","example":"20"},"discount_percent":{"type":"integer","example":"3"},"created_at":{"type":"string","example":"2022-06-15T10:08:29.000Z"}}},"BookInCartItem":{"type":"object","properties":{"id":{"type":"string","format":"int32","example":1},"isbn":{"type":"string","example":9783161484100},"name":{"type":"string","example":"ASP.NET Core v.6"},"description":{"type":"string","example":"It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout..."},"price":{"type":"number","example":"400.00"},"quantity":{"type":"number","example":5}}},"AddBookItem":{"type":"object","properties":{"name":{"type":"string","example":"ASP.NET Core v.6"},"description":{"type":"string","example":"It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout..."},"price":{"type":"number","example":"400.00"},"discount_percent":{"type":"integer","example":"3"},"isbn":{"type":"string","example":9783161484100}}},"UserItem":{"type":"object","properties":{"id":{"type":"integer","example":3},"email":{"type":"string","example":"iam@14devlab.co"},"first_name":{"type":"string","example":"Pichet"},"last_name":{"type":"string","example":"Suesat"},"phone_number":{"type":"string","example":"0812345678"}}},"UserAddressItem":{"type":"object","properties":{"id":{"type":"integer","example":6},"is_default":{"type":"boolean","example":true},"address_1":{"type":"string","example":"29/99 ซอยลงหาดบางแสน 14"},"address_2":{"type":"string","example":"ถนนลงหาดบางแสน"},"address_sub_district":{"type":"string","example":"แสนสุข"},"address_district":{"type":"string","example":"เมืองชลบุรี"},"address_province":{"type":"string","example":"ชลบุรี"},"address_postel_code":{"type":"string","example":"20130"},"address_country":{"type":"string","example":"TH"}}},"AddUserAddressItem":{"type":"object","properties":{"address_1":{"type":"string","example":"29/99 ซอยลงหาดบางแสน 14"},"address_2":{"type":"string","example":"ถนนลงหาดบางแสน"},"address_sub_district":{"type":"string","example":"แสนสุข"},"address_district":{"type":"string","example":"เมืองชลบุรี"},"address_province":{"type":"string","example":"ชลบุรี"},"address_postel_code":{"type":"string","example":"20130"},"address_country":{"type":"string","example":"TH"},"is_default":{"type":"boolean","example":true}}},"ShippingItem":{"type":"object","properties":{"id":{"type":"integer","example":3},"name":{"type":"string","example":"Kerry Express"},"price_per_piece":{"type":"number","example":40.0},"is_default":{"type":"boolean","example":true}}},"PaymentItem":{"type":"object","properties":{"id":{"type":"integer","example":3},"name":{"type":"string","example":"KBank"},"type":{"type":"string","enum":["bank_transfer","api"]},"account_number":{"type":"string","example":"202-22-2222-2"},"account_name":{"type":"string","example":"FIRSTNAME LASTNAME"},"account_bank":{"type":"string","example":"KBank"},"image_url":{"type":"string","example":"https://b.14devlab.co/assets/payment/kbank.jpg"},"is_default":{"type":"boolean","example":true}}},"OrderItem":{"type":"object","properties":{"book":{"type":"array","items":{"$ref":"#/definitions/BookInCartItem"}},"address":{"$ref":"#/definitions/UserAddressItem"},"shipping":{"$ref":"#/definitions/ShippingItem"},"payment":{"$ref":"#/definitions/PaymentItem"},"summary":{"type":"object","properties":{"book_price":{"type":"number","example":"4,800.00"},"shipping_price":{"type":"number","example":400.0},"total_price":{"type":"number","example":"5,200.00"},"book_quantity":{"type":"number","example":10}}}}},"LoginItem":{"type":"object","properties":{"email":{"type":"string","example":"iam@14devlab.co"},"password":{"type":"string","example":"P@ssW0rd"}}},"RegisterItem":{"type":"object","properties":{"email":{"type":"string","example":"iam@14devlab.co"},"password":{"type":"string","example":"P@ssW0rd"},"first_name":{"type":"string","example":"FIRSTNAME"},"last_name":{"type":"string","example":"LASTNAME"},"phone_number":{"type":"string","example":"0812345678"}}},"RegisterValidationItem":{"type":"object","properties":{"value":{"type":"string","example":"iam@14devlab.co"},"msg":{"type":"string","example":"Email address already taken"},"param":{"type":"string","example":"email"},"location":{"type":"string","example":"body"}}},"AddressValidationItem":{"type":"object","properties":{"msg":{"type":"string","example":"Invalid value"},"param":{"type":"string","example":"address_1"},"location":{"type":"string","example":"body"}}},"OrderMasterDetailItem":{"type":"object","properties":{"id":{"type":"number","example":34},"user_id":{"type":"number","example":1},"order_status":{"type":"string","enum":["pending_payment","wait_payment_confirm","payment_confirmed","packing","ready_to_ship","shiped"]},"book_quantity":{"type":"number","example":2},"total_book_price":{"type":"number","example":970.0},"total_shipping_price":{"type":"number","example":80.0},"total_grand_price":{"type":"number","example":"1,050.00"},"payment_id":{"type":"number","example":1},"payment_name":{"type":"string","example":"KBank"},"payment_status":{"type":"boolean","example":false},"payment_amount":{"type":"number","example":0},"payment_datetime":{"type":"string","example":null},"shipping_id":{"type":"number","example":1},"shipping_name":{"type":"string","example":"Kerry Express"},"shipping_price_per_piece":{"type":"number","example":40.0},"shipping_status":{"type":"boolean","example":"false,"},"shipping_tracking_info":{"type":"string","example":"${tracking url / tracking number}"},"address_id":{"type":"number","example":3},"address_1":{"type":"string","example":"29/99 ซอยลงหาดบางแสน 14"},"address_2":{"type":"string","example":"ถนนลงหาดบางแสน"},"address_sub_district":{"type":"string","example":"แสนสุข"},"address_district":{"type":"string","example":"เมืองชลบุรี"},"address_province":{"type":"string","example":"ชลบุรี"},"address_postel_code":{"type":"string","example":"20130"},"address_country":{"type":"string","example":"TH"},"first_name":{"type":"string","example":"Pichet"},"last_name":{"type":"string","example":"Suesat"}}},"OrderMasterBookItem":{"type":"object","properties":{"order_id":{"type":"number","example":34},"book_id":{"type":"string","format":"int32","example":1},"book_isbn":{"type":"string","example":9783161484100},"book_name":{"type":"string","example":"ASP.NET Core v.6"},"book_price":{"type":"number","example":500.0},"book_discount_percent":{"type":"number","example":3},"quantity":{"type":"number","example":2},"shipping_price_per_piece":{"type":"number","example":40.0},"total_book_price":{"type":"number","example":970.0},"total_shipping_price":{"type":"number","example":80},"total_grand_price":{"type":"number","example":"1,050.00"}}}},"securityDefinitions":{"Bearer":{"type":"apiKey","name":"Authorization","in":"header"}},"host":"b.14devlab.co"}