golang 주석으로 Swagger 사양 생성

Question

Swagger를 사용하여 golang으로 작성된 REST API에 대한 설명서를 만들려고합니다. 나는이 가이드를 따라왔다 : https://goswagger.io/generate/spec.html 이렇게하고 내 주 파일에 내 의견을 json 파일을 만들 수 있지만 실제 swagger 사양 변환 할 .yaml 파일을 만드는 방법을 모르겠다. 나는 페이지의 지침을 따라 주 파일에 //go:generate swagger generate spec을 포함 시켰습니다. 누구든지 .yaml 파일을 만드는 방법을 알고 있습니까?

Answer 1

생성 된 사양은이 단계에서 json이 아니며 yaml이 아니며 yaml을 수행 할 수 없다는 것을 말하는 것이 아니라 현재 json 만 생성합니다.

당신은 당신의 기본 패키지 주석을 달 수 있습니다 : 당신이 기본 패키지의 폴더에있을 때 go generate : //go:generate swagger generate spec -o swagger.json

은 다음과 사양을 생성 할 수 있습니다. 기본 패키지가 프로젝트 루트가 아니지만 $project_root/cmd/my-server과 같은 경우 프로젝트 루트에서 go generate ./cmd/my-server을 실행할 수 있습니다.