Git Product home page Git Product logo

go-clean-rest's Introduction

Golang Clean Architecture for REST API

Sample Golang Clean Architecture for REST API

Tools used

  • Web Framework: Gin
  • Database: MySQL
  • Cache: Redis
  • Config file: Viper

Project Description

REST API for posting some content/message with CRUD (Create, Read, Update, Delete) capability added with caching feature.

Structure

Based on repository pattern, this project use:

  • Repository layer: For accessing db in the behalf of project to store/update/delete data
  • Usecase layer: Contains set of logic/action needed to process data/orchestrate those data
  • Models layer: Contains set of entity/actual data attribute
  • Controller layer: Acts to mapping users input/request and presented it back to user as relevant responses

API Endpoints

POST /api/v1/post

Creates a new post

Examples:

{
    "title": "testing",
    "content": "contents",
    "image_url": "http://an.image",
    "category": "testing_post"
}

GET /api/v1/post

Get all posts

Examples responses:

[
  {
    "id": 1,
    "title": "testing",
    "slug": "testing-1",
    "content": "contents",
    "image_url": "http://an.image",
    "category": "testing_post"
  }
]

GET /api/v1/post/:id

Get post by id

Examples request:

http://localhost:5000/api/v1/post/1

Examples response:

{
    "id": 1,
    "title": "testing",
    "slug": "testing-1",
    "content": "contents",
    "image_url": "http://an.image",
    "category": "testing_post"
}

GET /api/v1/post/slug/:slug

Get post by slug

Examples request:

http://localhost:5000/api/v1/post/slug/testing-1

Examples response:

{
    "id": 1,
    "title": "testing",
    "slug": "testing-1",
    "content": "contents",
    "image_url": "http://an.image",
    "category": "testing_post"
}

GET /api/v1/post/title/:title

Get post by title

Examples request:

http://localhost:5000/api/v1/post/title/testing

Examples response:

{
    "id": 1,
    "title": "testing",
    "slug": "testing-1",
    "content": "contents",
    "image_url": "http://an.image",
    "category": "testing_post"
}

DELETE /api/v1/post/:id

Delete post by ID

Examples request:

http://localhost:5000/api/v1/post/1

PUT /api/v1/post/:id

Update post by ID

Examples request:

{
    "id": 1,
    "title": "testing",
    "slug": "testing-1",
    "content": "contents",
    "image_url": "http://an.image",
    "category": "testing_post"
}

Examples response:

{
    "message": "Post successfully updated!"
}

go-clean-rest's People

Contributors

ariefhirmanto avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.