ashikurrahaman287/restful-api-

Todo API

This is a simple RESTful API for managing a todo list, built with Go and the Gin web framework.

Table of Contents

• Prerequisites
• Installation
• Usage
• API Endpoints
• Docker
• Contributing
• License

Prerequisites

• Go 1.18 or higher
• Docker (optional, for containerization)

Installation

1. Clone the repository:

git clone https://github.com/Ashikurrahaman287/RESTful-API-.git
cd todo-api

2. Initialize the Go module and download dependencies:

go mod tidy

3. Install Gin framework:

go get github.com/gin-gonic/gin

Usage

1. Run the application:

go run main.go

2. The API will be available at http://localhost:8080.

API Endpoints

Create a new todo

• URL: /todos
• Method: POST
• Body:

{
"title": "New Todo"
}

• Success Response:
• Code: 201 CREATED
• Content:

{
"id": 1,
"title": "New Todo",
"completed": false
}

Get all todos

• URL: /todos
• Method: GET
• Success Response:
• Code: 200 OK
• Content:

[
{
"id": 1,
"title": "New Todo",
"completed": false
}
]

Get a todo by ID

• URL: /todos/:id
• Method: GET
• Success Response:
• Code: 200 OK
• Content:

{
"id": 1,
"title": "New Todo",
"completed": false
}

• Error Response:
• Code: 404 NOT FOUND
• Content:

{
"error": "Todo not found"
}

Update a todo

• URL: /todos/:id
• Method: PUT
• Body:

{
"title": "Updated Todo",
"completed": true
}

• Success Response:
• Code: 200 OK
• Content:

{
"id": 1,
"title": "Updated Todo",
"completed": true
}

• Error Response:
• Code: 404 NOT FOUND
• Content:

{
"error": "Todo not found"
}

Delete a todo

• URL: /todos/:id
• Method: DELETE
• Success Response:
• Code: 204 NO CONTENT
• Error Response:
• Code: 404 NOT FOUND
• Content:

{
"error": "Todo not found"
}

Docker

You can also run the application using Docker.

1. Build the Docker image:

docker build -t todo-api .

2. Run the Docker container:

docker run -p 8080:8080 todo-api

Contributing

If you want to contribute to this project, feel free to submit issues or pull requests. [email protected]

License

This project is licensed under the MIT License.