Golang과 Gin 프레임워크, SQLx 라이브러리를 활용한 REST API 개발 입문 가이드

서문
- REST API란 무엇인가?
- 왜 Golang, Gin, SQLx인가?
환경 설정
API 구축
결론

서문

Golang은 그 성능과 효율성으로 잘 알려진 프로그래밍 언어입니다. 이 글에서는 Golang의 Gin 프레임워크와 SQLx 라이브러리를 사용하여 기본적인 REST API를 구현하는 방법을 설명합니다. 초보자부터 중급 개발자에 이르기까지 다양한 코드 예제를 풍부하게 준비했습니다.

REST API란 무엇인가?

REST API(Representational State Transfer API)는 웹 애플리케이션 또는 서비스 간의 통신에 사용되는 아키텍처 스타일입니다. 이는 HTTP 프로토콜을 사용하여 데이터를 교환하고 리소스의 상태를 조작합니다.

왜 Golang, Gin, SQLx인가?

Golang은 빠르고 효율적인 백엔드 개발에 적합합니다. Gin 프레임워크는 그 간결함과 성능으로 Golang 웹 애플리케이션 개발에서 인기가 있습니다. 한편, SQLx는 데이터베이스 작업을 쉽게 만들어주는 라이브러리입니다.

환경 설정

먼저 Golang, Gin, SQLx를 설치합니다. 다음 명령을 실행하세요.

go get -u github.com/gin-gonic/gin
go get -u github.com/jmoiron/sqlx

이제 개발에 필요한 기본 환경이 갖춰졌습니다.

API 구축

단계 1: 기본 서버 설정

다음은 기본적인 Gin 서버 설정 예제입니다.

package main

import (
    "github.com/gin-gonic/gin"
    "net/http"
)

func main() {
    router := gin.Default()

    router.GET("/", func(c *gin.Context) {
        c.JSON(http.StatusOK, gin.H{"message": "Hello World"})
    })

    router.Run(":8080")
}

이 코드는 8080 포트에서 서버를 시작하고, 루트 경로에 접근하면 “Hello World”라는 메시지를 JSON 형식으로 반환합니다.

단계 2: 데이터베이스 연결

다음으로, SQLx를 사용하여 데이터베이스에 연결합니다.

package main

import (
    "github.com/gin-gonic/gin"
    "github.com/jmoiron/sqlx"
    _ "github.com/lib/pq"
)

var db *sqlx.DB

func init() {
    var err error
    db, err = sqlx.Connect("postgres", "user=foo dbname=bar sslmode=disable")
    if err != nil {
        panic(err)
    }
}

func main() {
    router := gin.Default()
    router.GET("/", func(c *gin.Context) {
        c.JSON(200, gin.H{
            "message": "DB connected",
        })
    })

    router.Run(":8080")
}

이 코드는 PostgreSQL 데이터베이스에 연결하고, 연결이 성공했음을 확인하기 위한 기본 엔드포인트를 제공합니다.

단계 3: CRUD 작업 구현

마지막으로, CRUD(생성, 읽기, 업데이트, 삭제) 작업을 구현합니다. 다음은 간단한 사용자 생성 및 사용자 정보 가져오기 예제입니다.

package main

// 다른 import 문은 생략...

type User struct {
    ID    int    `db:"id"`
    Name  string `db:"name"`
    Email string `db:"email"`
}

func createUser(c *gin.Context) {
    var user User
    if err := c.BindJSON(&user); err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
        return
    }

    _, err := db.NamedExec(`INSERT INTO users (name, email) VALUES (:name, :email)`, &user)
    if err != nil {
        c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
        return
    }

    c.JSON(http.StatusCreated, user)
}

func getUser(c *gin.Context) {
    id := c.Param("id")
    var user User
    err := db.Get(&user, "SELECT * FROM users WHERE id=$1", id)
    if err != nil {
        c.JSON(http.StatusNotFound, gin.H{"error": "User not found"})
        return
    }

    c.JSON(http.StatusOK, user)
}

func main() {
    // 라우터 및 데이터베이스 연결 설정은 생략...

    router.POST("/users", createUser)
    router.GET("/users/:id", getUser)

    router.Run(":8080")
}

이 코드는 새 사용자를 생성하기 위한 엔드포인트와 특정 사용자를 가져오기 위한 엔드포인트를 제공합니다.

결론

이 글에서는 Golang의 Gin 프레임워크와 SQLx 라이브러리를 사용하여 기본적인 REST API를 구축하는 방법을 소개했습니다. 이러한 도구들은 효율적이고 유연한 API 개발을 가능하게 합니다. 이 지식을 활용하여 자신의 프로젝트에 도전해 보세요.