Golang을 사용하여 RESTful API를 구축하고 Swagger 문서를 사용하는 방법은 무엇입니까?-Golang-php.cn

Golang을 사용하여 RESTful API를 구축하고 Swagger 문서를 사용하는 방법은 무엇입니까?

WBOY

풀어 주다： 2024-06-05 20:48:59

원래의

850명이 탐색했습니다.

Go를 사용하여 RESTful API를 구축하고 Swagger 문서에서 읽을 수 있는 엔드포인트 설명을 제공하세요. Go 모듈을 만들고 Gin 프레임워크를 사용하세요. API 문서를 생성하려면 Swagger 문서를 추가하세요. "Create User"와 같은 엔드포인트를 정의하고 그에 따라 Swagger 정의를 작성합니다.

如何使用 Golang 构建 RESTful API 并使用 Swagger 文档？

Golang을 사용하여 RESTful API 구축 및 Swagger 문서 사용

소개

RESTful API 구축은 현대적이고 상호 운용 가능한 웹 서비스를 만들기 위한 기반입니다. Go 언어는 고성능의 확장 가능한 API를 구축하는 데 필요한 도구와 라이브러리를 제공합니다. 또한 Swagger 문서는 API 문서를 자동으로 생성하는 데 도움이 되므로 개발자가 API를 쉽게 이해할 수 있습니다.

RESTful API 구축

Go 모듈 생성

go mod init rest-api

로그인 후 복사

Gin 프레임워크 사용

import "github.com/gin-gonic/gin"

func main() {
    r := gin.Default()
    r.GET("/users", getUsers)
    r.Run(":8080")
}

func getUsers(c *gin.Context) {
    c.JSON(200, "Hello world!")
}

로그인 후 복사

Swagger 문서 추가

import "github.com/swaggo/swag/example/restapi/swagger"

swagger.Register(r)

로그인 후 복사

애플리케이션 실행:

go run main.go

로그인 후 복사

실용 예

사용자 관리 API를 구축한다고 가정해 보겠습니다. 다음 코드를 사용하여 사용자 생성을 위한 엔드포인트를 생성할 수 있습니다.

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

    if err := userService.Create(user); err != nil {
        c.JSON(500, gin.H{"error": err.Error()})
        return
    }

    c.JSON(201, user)
}

로그인 후 복사

이 코드에는 사용자 생성을 위한 userService가 필요합니다. 또한 Swagger 사양에 따라 해당 Swagger 정의를 작성해야 합니다.