62stingray is a REST API written in Golang designed to manage user defined cart data and can run independly as a stateless service.
The main goal of 62stingray is to reduce repetition of creating and managing cart data.
Created by 62teknologi.com, perfected by Community.
This introduction will help You explain the concept and characteristic of cart.
Cart refers to a virtual container or a shopping cart that allows users to gather and store items they wish to purchase from an online store.
In the context of a 62stingray, a cart need has certain Information and Behaviors. Additionally, a cart also can have information of User Defined Data.
You will learn how to define data on later section.
- Must Have ID
- Must Have User/Guest ID
- Must Have Product ID
- Must Have Created At
- Must Have Updated At
- Must Have Deleted At
- can be retrieved
- can be added
- can be synched
- can be deleted
Follow the instruction below to running 62stingray on Your local machine.
Make sure to have preinstalled this prerequisites app before You continue to installation manual. we don't include how to install these app below most of this prerequisites is a free app which You can find the "How to" installation tutorial anywhere in web and different machine OS have different way to install.
- MySql
- Go
This installation manual will guide You to running the binary on Your ubuntu or mac terminal.
- Clone the repository
git clone https://github.com/62teknologi/62stingray
- Change directory to the cloned repository
cd 62stingray
- Initiate the submodule
git submodule update --init
- Create .env base on .env.example
cp .env.example .env
- Change DB variable on .env using Your mysql configuration or the staging database on cloud server eg
HTTP_SERVER_ADDRESS=0.0.0.0:10082
DB_DRIVER=mysql
DB_SOURCE_1=root@tcp(127.0.0.1:3306)/stingray_local
- Build the binary
go build main.go
- Run the server
./main
The API server will start running on http://localhost:10082. You can now interact with the API using Your preferred API client or through the command line with curl.
GET /api/v1/carts
| Name | Def | Description |
|---|---|---|
| page | 1 | return response in pagination format, eg: page=1 will return first page of the response |
| per_page | 30 | set how many data per pagination response |
| search | null | filter response by string |
| order | null | order data by one or multiple field, eg: order=name+asc or order[]=name+asc&order[]=created_at+desc |
| :field | null | filter specific column You want, eg: if Your cart have user_id field then You can add user_id=1 to params for searching all cart where user_id is 1. it support multi value by sending user_id[] instead user_id |
GET /api/v1/carts
| Name | Def | Description |
|---|---|---|
| :field | null | field You want to insert |
| user_id | null | identify the cart owner, for example You can use Your user session id for Your aunthicated user or sort of web cookies id for Your guest user |
| product_id | null | identify the product of cart, for example You can use Your item_id, book_id, food_id etc |
PUT /api/v1/carts
| Name | Def | Description |
|---|---|---|
| ids[] | null | cart id that You want to synch |
| quantities[] | null | quantity of product in cart that You want to synch. Quantity length need to be the same with id length |
| user_id | null | identify the cart owner You want to synch. Synch will not have effect if user_id not found |
DEL /api/v1/carts/:user_id/:id
- WIP
- WIP
- WIP
- WIP
- WIP
- WIP
- WIP
- WIP
If You'd like to contribute to the development of the 62stingray REST API, please follow these steps:
- Fork the repository
- Create a new branch for Your feature or bugfix
- Commit Your changes to the branch
- Create a pull request, describing the changes You've made
We appreciate Your contributions and will review Your pull request as soon as possible.
- Reduce repetition
- Easy to use REST API
- Easy to setup
- Easy to Customizable
- high performance
- Robust data validation and error handling
- Well documented API endpoints
This project is licensed under the MIT License. For more information, please see the LICENSE file.
E.nam\Du.a
Indonesian language; spelling: A-num\Due-wa
Origin: Enam Dua means ‘six-two’ or sixty two. It is Indonesia’s international country code (+62), that was also used as a meme word for “Indonesia” by “Indonesian internet citizen” (netizen) in social media.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent