Swagger codeGen
🧰 Swagger-codeGen
정의
Swagger-codeGen은 Swagger/OpenAPI 명세를 기반으로 서버 코드, 클라이언트 코드, 문서를 자동 생성하는 도구다.
Swagger가 API를 설명하는 문서화 도구라면, Swagger-codeGen은 그 명세를 이용해 산출물을 만들어내는 도구에 가깝다.
⚙️ 주요 특징
- OpenAPI 명세 파일을 입력으로 사용한다.
- 서버 스텁이나 클라이언트 SDK를 생성할 수 있다.
- 문서 형식도 함께 생성할 수 있다.
- 반복적인 API 연동 코드를 줄이는 데 도움이 된다.
🛠️ 사용 절차
swagger-codegen-cli.jar를 준비한다.api-docs.json또는 OpenAPI 명세 파일을 준비한다.- 생성 명령을 실행한다.
java -jar <codegen-cli 경로> generate -i <api-docs.json 경로> -l <생성 문서 타입> -o <output 디렉터리 경로>
📦 생성 형식 예시
| 형식 | cli |
|---|---|
| HTML | html |
| HTML2 | html2 |
| Markdown | markdown |
| Confluence Wiki | confluenceWiki |
| AsciiDoc | asciidoc |
| PlantUML | plantuml |
| Static Docs | dynamic-html |
📌 정리
- Swagger-codeGen은 API 명세를 코드와 문서로 바꿔주는 도구다.
- Swagger 문서와 같이 보면 흐름이 더 잘 보인다.
- 명세가 자주 바뀌는 프로젝트에서 특히 유용하다.
댓글남기기