1 of 9

OpenAPI 문서

OpenAPI 문서 관리

2 of 9

OpenAPI 문서 관리

OpenAPI 문서 관리

​

동기화

코드

API 문서

주석만 잘 달면

코드만 수정해도 자동으로

API 문서 업데이트

3 of 9

OpenAPI 문서 관리

OpenAPI 문서 관리 - swaggo

​

swaggo 공식 문서

원래는 코드 수정하면

swag init -g cmd/main.go

명령어 수동 실행해야함

설치 필수

4 of 9

OpenAPI 문서 관리

5 of 9

OpenAPI 문서 관리

OpenAPI 문서 관리 - swaggo

​

swaggo 공식 문서

원래는 코드 수정하면

swag init -g cmd/main.go

명령어 수동 실행해야함

커밋할때 자동으로 실행하도록 설정함

(.pre-commit-config.yaml 참고)

자동화

설치 필수

6 of 9

OpenAPI 문서 관리

OpenAPI 문서 관리 - 기본 설정

host + 엔드포인트

title, version, BasePath

description

schemes

main.go에서

swagger 문서 기본 정보 설정

7 of 9

OpenAPI 문서 관리

OpenAPI 문서 관리 - 주석

@Tags

@Router

@Summary

@Param

@Success

필수 항목

  • Summary
  • Tags
  • Param
  • Success
  • Router

선택 항목

  • Description
  • Accept
  • Produce
  • Failure

8 of 9

OpenAPI 문서 관리

OpenAPI 문서 관리 - Param

@Param [이름] [형식] [타입] [필수여부] “설명”

request, response는 따로 정의해두고 사용 가능

9 of 9

OpenAPI 문서 관리

OpenAPI 문서 관리 - 커밋시 자동으로 문서 업데이트

Pre-commit 단계에서 자동으로

openAPI 문서 업데이트 후 함께 커밋