소개

TypeScript는 웹 개발에 점점 더 많이 채택되고 있습니다
제가 담당하고 있는 개발에서는 프론트엔드와 백엔드 모두 TypeScript를 사용하고 있으며, 안전한 개발을 위해 프론트엔드와 백엔드 간에 유형 정의를 공유하고 싶은 것은 당연하다고 생각합니다

이 문서에서는 토토 사이트 Editor를 사용하여 OpenAPI 사양에 따라 API 사양을 생성하는 방법과 openapi-typescript를 사용하여 TypeScript용 유형 정의 파일을 출력하여 프런트 엔드와 백엔드 간의 유형 안전 개발을 달성하는 방법을 설명합니다

토토 사이트 Editor를 사용하여 API 사양을 작성하는 방법

토토 사이트 Editor는 OpenAPI 사양을 준수하는 API 사양을 생성하기 위한 도구입니다
웹 브라우저에서 사용할 수 있지만 Visual Studio Code를 IDE로 사용하는 경우 확장으로 제공됩니다

토토 사이트 Editor를 사용하면 YAML 또는 JSON 형식으로 API 사양을 생성할 수 있습니다
다음은 간단한 예입니다

sample_apiyml

openapi:3.0.1정보:1.0.0설명: API 사양 샘플'200':유형: 배열유형:객체속성:id:유형: 번호유형: 문자열

openapi-typescript를 사용하는 TypeScript용 유형 정의 파일 출력

openapi-typescript는 OpenAPI 스키마를 TypeScript로 변환하는 도구입니다
이를 통해 OpenAPI 사양을 준수하는 API 사양을 기반으로 유형 정의 파일이 자동으로 생성될 수 있으므로 프런트엔드와 백엔드 간에 편안하고 유형이 안전한 개발이 가능해집니다
다음은 이전에 토토 사이트 Editor에서 생성한 Sample_apiyml을 입력으로 사용하는 예입니다

npx openapi-typescript /api-schema/documents/sample_apiyml-o /api-schema/src/스키마ts-t 유형--루트 유형

프런트엔드와 백엔드 모두에 TypeScript를 사용하려면 openapi-typescript 사용을 고려해 보세요