Categorygithub.com/saketV8/basic-crud-api-golang

modulepackage

0.0.0-20241204190138-dff7af6de8b4

Repository: https://github.com/saketv8/basic-crud-api-golang.git

Documentation: pkg.go.dev

# README

API For User Account Management

CRUD API for user account management, where users can add, update, delete, and request details about their accounts.

[!NOTE]

This is only the backend of the CRUD REST API service, as requested in the task

:computer: Tech Stack

Go : Programming language
Gin : Web framework
SQLite : Database (embedded in sqlite driver)
SQLite Driver : A sqlite3 driver
Goose : A database migration tool

:star2: Features

POST: Create User Account
GET: Read/Show User Account
UPDATE: Update User Account
DELETE: Delete User Account

support CRUD operations

:book: How to Use / Run on Your Machine

Prerequisites:
- Install Go (version >= 1.23.3): https://golang.org/dl/
- Install Goose: https://github.com/pressly/goose
- API Testing Tool
  - Postman
  - Httpie

I am using HttPie for API testing

you can use Postman too.

Installation:
- Clone the repository:
```
git clone https://github.com/SaketV8/basic-crud-api-golang.git
```
- Navigate to the project directory:
```
cd basic-crud-api-golang
```
- Install dependencies:
```
go mod tidy
```
- Generate the Table and default Data:
```
goose -dir=databases/migrations sqlite3 app.db up
```
- Run the API:
```
go run main.go
```
:rocket: You're all set! The API server is now running

The server is running on PORT 8080 (or a different port depending on your setup). Please check the terminal logs for the exact port

:books: Additional Info

DB Table name

user_accounts

Clear the Database

goose -dir=databases/migrations sqlite3 app.db down

create the migration for table - user_accounts

goose -dir=databases/migrations create user_accounts sql

Check databases/migrations/

# This folder contains the database migration code

:electric_plug: API Endpoints:

Available End Points
- GET /api/test-api: Test API
- GET /api/users: Fetch all users
- GET /api/user/:user_name: Fetch user by user_name
- POST /api/create-user-account: Create a new user
- PUT /api/update-user-account: Update user information
- DELETE /api/delete-user-account: Delete a user

:hammer_and_wrench: API Example of GET, POST, PUT, DELETE

GET

GET /api/users

POST

POST /api/create-user-account

# BODY of request
{
  "user_name": "rohit_sharma",
  "first_name": "Rohit",
  "last_name": "Sharma",
  "phone_number": "82834-90123",
  "email": "[email protected]"
}

PUT

PUT /api/update-user-account

# BODY of request
{
  "user_name": "rohit_sharma",
  "first_name": "Rohit",
  "last_name": "Sharma",
  "phone_number": "82834-90123",
  "email": "[email protected]"
}

DELETE

DELETE /api/delete-user-account

# BODY of request
{
  "user_name": "rohit_sharma"
}

:jigsaw: Usage Examples

:seedling: Todo / Future Improvements

:compass: About

This project was created as a task for the backend department recruitment process at ABES GeeksforGeeks

:label: Attribution

API icon created by Freepik - Flaticon

License

MIT License

Copyright (c) 2024 Saket Maurya

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.