golang API 문서를 생성하기 위해 swag를 설치하는 방법

Swag는 Swagger 문서를 자동으로 생성하는 Go 애플리케이션을 빠르게 구축하기 위한 도구입니다. 개발자는 코드에 몇 가지 설명을 추가하기만 하면 자동으로 API 문서를 생성할 수 있습니다. Swag는 RESTful API 표준에 따라 API 문서 생성을 지원하고 Markdown 및 HTML 형식 생성도 지원합니다.

이 글에서는 golang에서 Swag를 설치하고 사용하는 방법을 소개하겠습니다.

1단계 - Swag 설치

Swag는 go get 명령을 사용하여 GitHub에서 설치할 수 있습니다. 다음 명령을 사용하여 Swag를 설치할 수 있습니다.

$ go get github.com/swaggo/swag/cmd/swag

설치가 완료되면 $에서 "swag" 바이너리 파일을 찾을 수 있습니다. GOPATH/빈 경로. 이제 계속해서 Swag를 사용하여 API 문서를 생성할 수 있습니다.

2단계 - API 문서 생성

Swag에서는 API 문서를 올바르게 생성하려면 몇 가지 특별한 코드 주석이 필요합니다. 다음은 몇 가지 예시 댓글입니다.

// @Summary 创建用户
// @Description 创建一个新用户
// @Tags 用户管理
// @Accept json
// @Produce json
// @Param user body User true "用户信息"
// @Success 200 {string} string "成功"
// @Failure 400 {string} string "请求错误"
// @Failure 500 {string} string "服务器内部错误"
// @Router /users [post]
func CreateUser(c *gin.Context) {
    // ...
}

위의 댓글은 사용자를 생성하는 방법에 대한 API를 설명합니다. Swag는 코드에서 이러한 특수 주석을 검색한 다음 문서를 작성합니다.

다음 명령을 실행하여 문서를 생성하세요.

$ swag init

이렇게 하면 애플리케이션을 스캔하고 Swagger JSON 파일과 Swagger UI가 생성됩니다.

3단계 - Swagger UI 추가

Swagger UI는 API를 보고 테스트하기 위한 대화형 인터페이스를 제공합니다. 웹 애플리케이션에 Swagger UI를 추가할 수 있습니다.

// main.go
package main

import (
    "net/http"

    "github.com/gin-gonic/gin"
    "github.com/swaggo/files" // swagger embed files
    "github.com/swaggo/gin-swagger" // gin-swagger middleware
    _ "github.com/user/repo/docs" // docs is generated by Swag CLI, you have to import it.
)

func main() {
    r := gin.New()

    // use ginSwagger middleware to serve the API docs
    r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))

    //...
}

Swag를 사용하여 문서를 생성했다고 가정합니다. 이제 브라우저에서 다음 링크를 열어 API 문서를 볼 수 있습니다.

http://localhost:8080/swagger/index.html

이것은 API를 보고 테스트하는 데 사용할 수 있는 Swagger의 웹 UI입니다.

요약

이 글에서는 Golang에서 Swag를 설치하고 사용하는 방법을 소개했습니다. Swagger의 주석과 명령을 사용하면 API 문서를 쉽게 생성할 수 있습니다. Swag를 사용하면 전체 프로세스가 빠르고 쉬워지며 Swag를 사용한 문서는 Swagger UI와 잘 통합됩니다.

위 내용은 golang API 문서를 생성하기 위해 swag를 설치하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!