https://github.com/thecoderdream/go-todo-list-crud-rest-api
https://github.com/thecoderdream/go-todo-list-crud-rest-api
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/thecoderdream/go-todo-list-crud-rest-api
- Owner: TheCoderDream
- Created: 2023-06-28T22:58:52.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-29T09:06:36.000Z (almost 3 years ago)
- Last Synced: 2025-05-14T04:19:32.069Z (about 1 year ago)
- Language: Go
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Todo List REST API
This is a Todo List application with a RESTful API built using Go, GORM for PostgreSQL database integration, and Gorilla for HTTP routing.
## Features
- User Authentication: The API supports user authentication using JSON Web Tokens (JWT). Users can register, log in, and access protected routes by providing a valid JWT.
- Task Management: The API allows users to create, read, update, and delete tasks. Each task has properties such as a title, description, due date, priority, and completion status.
- Task Filtering and Sorting: Users can retrieve tasks based on specific criteria such as due date, priority, completion status, or any other custom attributes. The API provides query parameters to filter and sort tasks accordingly.
- Pagination: The API supports pagination of task results, enabling the retrieval of tasks in smaller, manageable chunks. Users can specify the page number and the number of tasks per page.
## Endpoints
- `POST /register`: Register a new user with a unique username and password. Returns a JWT upon successful registration.
- `POST /login`: Log in with a registered username and password. Returns a JWT upon successful login.
- `GET /tasks`: Retrieve all tasks. Supports filtering, sorting, and pagination. Query parameters can be used to filter tasks based on due date, priority, completion status, etc. Pagination parameters (`page` and `limit`) can be used to control the number of tasks returned per page and the current page number.
- `POST /tasks`: Create a new task by providing the necessary details in the request body.
- `GET /tasks/{id}`: Retrieve a specific task by its ID.
- `PUT /tasks/{id}`: Update an existing task by providing the updated details in the request body.
- `DELETE /tasks/{id}`: Delete a specific task by its ID.
## Installation
##### Clone the repository:
```bash
git clone https://github.com/your-username/todo-list-api.git
```