https://github.com/mingrammer/go-todo-rest-api-example
:books: A RESTful API example for simple todo application with Go
https://github.com/mingrammer/go-todo-rest-api-example
example practice-golang rest-api tutorial
Last synced: 21 days ago
JSON representation
:books: A RESTful API example for simple todo application with Go
- Host: GitHub
- URL: https://github.com/mingrammer/go-todo-rest-api-example
- Owner: mingrammer
- Created: 2017-04-11T12:10:35.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-21T13:02:16.000Z (about 1 year ago)
- Last Synced: 2025-04-02T08:16:33.032Z (28 days ago)
- Topics: example, practice-golang, rest-api, tutorial
- Language: Go
- Homepage:
- Size: 14.6 KB
- Stars: 558
- Watchers: 28
- Forks: 243
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Go Todo REST API Example
A RESTful API example for simple todo application with Go
It is a just simple tutorial or example for making simple RESTful API with Go using **gorilla/mux** (A nice mux library) and **gorm** (An ORM for Go)
## Installation & Run
```bash
# Download this project
go get github.com/mingrammer/go-todo-rest-api-example
```
Before running API server, you should set the database config with yours or set the your database config with my values on [config.go](https://github.com/mingrammer/go-todo-rest-api-example/blob/master/config/config.go)
```go
func GetConfig() *Config {
return &Config{
DB: &DBConfig{
Dialect: "mysql",
Username: "guest",
Password: "Guest0000!",
Name: "todoapp",
Charset: "utf8",
},
}
}
```
```bash
# Build and Run
cd go-todo-rest-api-example
go build
./go-todo-rest-api-example
# API Endpoint : http://127.0.0.1:3000
```
## Structure
```
├── app
│ ├── app.go
│ ├── handler // Our API core handlers
│ │ ├── common.go // Common response functions
│ │ ├── projects.go // APIs for Project model
│ │ └── tasks.go // APIs for Task model
│ └── model
│ └── model.go // Models for our application
├── config
│ └── config.go // Configuration
└── main.go
```
## API
#### /projects
* `GET` : Get all projects
* `POST` : Create a new project
#### /projects/:title
* `GET` : Get a project
* `PUT` : Update a project
* `DELETE` : Delete a project
#### /projects/:title/archive
* `PUT` : Archive a project
* `DELETE` : Restore a project
#### /projects/:title/tasks
* `GET` : Get all tasks of a project
* `POST` : Create a new task in a project
#### /projects/:title/tasks/:id
* `GET` : Get a task of a project
* `PUT` : Update a task of a project
* `DELETE` : Delete a task of a project
#### /projects/:title/tasks/:id/complete
* `PUT` : Complete a task of a project
* `DELETE` : Undo a task of a project
## Todo
- [x] Support basic REST APIs.
- [ ] Support Authentication with user for securing the APIs.
- [ ] Make convenient wrappers for creating API handlers.
- [ ] Write the tests for all APIs.
- [x] Organize the code with packages
- [ ] Make docs with GoDoc
- [ ] Building a deployment process