OpenAPI 트리머로 OpenAPI 파일 단순화

대규모 OpenAPI 파일을 관리하는 것은 번거로울 수 있으며, 특히 특정 작업에 API의 작은 부분만 필요한 경우에는 더욱 그렇습니다. 이것이 OpenAPI 트리머가 유용한 곳입니다. 관심 있는 엔드포인트와 데이터 전송 개체(DTO)만 포함하도록 OpenAPI 파일을 정리하도록 설계된 경량 도구입니다.

어떻게 작동하나요?

대규모 OpenAPI 파일로 작업 중이지만 Quotes API와 관련된 엔드포인트만 필요하다고 가정해 보겠습니다. 단일 명령으로 쉽게 해당 엔드포인트만 추출하고 관련 없는 DTO를 제거할 수 있습니다:

openapi-trimmer -i openapi.yaml \
  -p /v1/quotes,/v1/users \
  -ec CompanyConfigDto,UpdateCompanyConfigDto

이 명령은 다음을 수행합니다.

• -i openapi.yaml: 기존 OpenAPI YAML 파일을 입력으로 사용합니다.
• -p /v1/quotes,/v1/users: /v1/quotes 및 /v1/users로 시작하는 엔드포인트만 유지합니다.
• -ec CompanyConfigDto,UpdateCompanyConfigDto: 특정 구성 요소(이 경우 CompanyConfigDto 및 UpdateCompanyConfigDto)를 제외합니다.

잘린 API 정의는 openapi-trimmer.yaml로 저장됩니다.

확인

잘린 OpenAPI 파일의 무결성을 보장하려면 다음을 사용하여 유효성을 검사하세요.

swagger-cli validate ./openapi-trimmer.yaml

이 단계는 정리된 API 파일을 배포하거나 공유하기 전에 문제를 파악하는 데 도움이 됩니다.

설치

PyPi에서 OpenAPI Trimmer를 직접 설치할 수 있습니다.

pip install openapi-trimmer

자세한 내용과 최신 업데이트를 확인하려면 OpenAPI Trimmer PyPi 페이지를 방문하세요.

GitHub 저장소: GitHub의 OpenAPI Trimmer.

명령줄 옵션

OpenAPI Trimmer는 작업을 사용자 정의할 수 있는 여러 옵션을 제공합니다.

• -h, --help: 도움말 정보를 표시합니다.
• -v, --version: 버전 번호를 표시합니다.
• -i INPUT, --input INPUT: 입력 YAML 파일을 지정합니다(필수).
• -o OUTPUT, --output OUTPUT: 출력 파일 이름을 정의합니다(선택 사항, 기본값은 입력 파일에 '-trimmed'를 추가하는 것임).
• -p PREFIXES, --prefixes PREFIXES: 출력에 유지할 경로를 나열합니다(쉼표로 구분).
• -ec EXCLUDE_COMPONENTS, --exclude-comComponents EXCLUDE_COMPONENTS: 제외할 구성요소를 나열합니다(쉼표로 구분).

결론

OpenAPI Trimmer는 OpenAPI 파일을 간소화하여 특정 요구 사항에 맞게 관리하고 맞춤화하려는 개발자에게 필수적인 도구입니다. API 문서를 준비하든 내부 사용을 위해 API를 단순화하든 OpenAPI Trimmer는 가장 중요한 사항에만 집중하여 시간과 노력을 절약해 줍니다.