API 명세·릴리스 노트 작성기
git log --oneline을 붙여 넣으면 커밋을 분류해 다음 버전(SemVer)과 사용자용·개발자용 릴리스 노트를 만들고, 엔드포인트 표로 API 문서·curl/fetch 예시·OpenAPI 3 YAML 초안을 뽑습니다.
커밋 목록
릴리스 노트
API 기본 정보
엔드포인트
필드는 한 줄에 하나씩 이름 타입 필수 설명 — 타입: string · int · number · bool · date · datetime · email · uuid · object · 타입[] (배열). 오류는 404 설명. 경로 변수는 /orders/{orderId}처럼.
결과
OpenAPI 3.0.3 초안입니다. Swagger Editor·Redoc·Postman에 붙여 넣어 확인하고, 실제 응답 예시·오류 형식은 서버 구현에 맞춰 고치세요.
기준: Conventional Commits 1.0.0, Semantic Versioning 2.0.0, OpenAPI Specification 3.0.3. 분류는 커밋 메시지 규칙과 단어로 추정한 참고용 초안이니, 배포 전 담당자가 내용을 확인하세요.
API 명세·릴리스 노트 작성기 사용 설명 · 이렇게 쓰세요
무엇을 하나요? git 커밋 목록을 붙여 넣으면 feat·fix·호환 깨짐 등으로 분류해 다음 버전(SemVer)과 사용자용·개발자용 릴리스 노트를 만들고, 엔드포인트 표로 API 문서·curl/fetch 예시·OpenAPI 3 YAML 초안을 만듭니다.
누가 쓰나요? 개발자, 테크 리드, PM·기획자, 고객에게 업데이트를 알리는 운영 담당자
이럴 때 쓰세요
- 배포 때마다 커밋 로그를 훑어 공지와 변경 이력을 따로 쓴다
- 다음 버전 번호를 무엇으로 할지 매번 고민한다
- API가 바뀔 때 문서·예시 코드·OpenAPI 파일을 손으로 맞춘다
좋은 점
- Conventional Commits 규칙과 단어로 자동 분류하고 버전 제안 근거를 보여 줍니다
- 쉬운 말 사용자 공지와 해시·PR 번호가 담긴 개발자 노트를 한 번에 만듭니다
- 엔드포인트 표 하나로 마크다운 문서·예시 요청·OpenAPI YAML을 만듭니다
사용 순서
- 예시 불러오기를 눌러 예시 결과를 먼저 봅니다
- 「릴리스 노트」 탭에서 현재 버전을 넣고 git log --oneline 결과를 붙여 넣습니다
- 릴리스 노트 만들기를 누르고 사용자용·개발자용을 바꿔 가며 다듬습니다
- 마크다운 복사 또는 HTML 복사로 공지·CHANGELOG에 붙여 넣습니다
- 「API 명세」 탭에서 엔드포인트를 적고 API 문서 만들기를 누른 뒤 OpenAPI YAML을 복사하거나 YAML 파일 저장을 누릅니다
팁 git log --oneline v1.4.2..HEAD 처럼 지난 태그 이후만 붙여 넣으면 이번 배포분만 정리됩니다. 0.x 버전이면 호환 깨짐을 MINOR로 올릴지 MAJOR(1.0.0)로 올릴지 고를 수 있습니다.
무료 · 회원가입·설치 없음 · 1회 약 45분 절약 · 개발 · IT·SaaS