OpenAPI Generator 사용법

OpenAPI Generator란?

API 스펙을 기반으로 코드들을 자동으로 생성해주는 도구 

 

왜 필요할까?

시스템 규모가 크면 API 가 엄청 늘어나는데

프론트에서 이 많은 API들의 입출력을 정의하는 것이 번거로움

또한, 요구사항 변경으로 인해 API 스펙이 변경되면 이를 재정의해야하는 상황

 

사용법

1. openAPI Generator 설치

    1) 프로젝트 내 설치

npm install @openapitools/openapi-generator-cli -D

    2) 글로벌 설치

npm install @openapitools/openapi-generator-cli -g

 

2. 루트 폴더에 openapi.json 파일 추가

{
  "modelPackage": "src/domain/model",
  "apiPackage": "src/domain/api",
  "withSeparateModelsAndApi": true
}

3. API 스펙 검증

openapi-generator-cli validate -i {API문서명}

 

4. API 모델 생성

•  -i : OpenAPI 문서 지정
• -o : 디렉토리 지정
• -g : generator 지정 (ex. typescript-axios, javascript, kotlin-spring, kotlin....)
• skip-validate-spec : 검증 skip

openapi-generator-cli generate -i http://localhost/v2/api-docs -g javascript -o ./models --skip-validate-spec

 

https://openapi-generator.tech/docs/installation

OpenAPI Generator · Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents