이 OpenAPI 도구가 하는 일
프론트엔드 작업은 백엔드가 준비되기 전에 시작되며, 이미 스펙이 있는 API를 위해 손으로 타입을 작성하는 것은 낭비된 노력입니다. JSON 또는 YAML에서 OpenAPI 3.x 또는 Swagger 2.0 문서를 붙이면 이 도구는 세 가지를 생성합니다: 모든 작업에 대한 현실적인 모크 응답, 모든 스키마에 대한 타이프스크립트 타입, 그리고 엔드포인트당 하나의 함수를 가진 작은 입력된 페치 클라이언트 모든 것이 브라우저에서 생성되므로 개인 또는 내부 API 사양은 결코 업로드되지 않습니다.
사용 방법
- 스펙을 붙여주거나 파일을 업로드하세요. JSON와 YAML 모두 받아들여집니다.
- 엔드포인트 목록은 모든 동작과 그 방법과 경로를 보여줍니다.
- ** 모의 데이터** 탭을 열고, 스키마 예제, 형식 및 enums에서 만들어진 샘플 응답을 보기 위해 작업을 선택합니다.
components/schemas(또는 Swagger 2의definitions) 에서 생성된 인터페이스에 대해 TS 타입로 전환합니다.- 사용 준비된 클라이언트를 위해 TS 클라이언트로 전환하고 프로젝트로 복사하세요.
모의가 어떻게 만들어지는지
example와examples값은 항상 승리합니다.enum은 첫 번째 값을 선택하고,default는 존중됩니다.- 문자열 형식은
email,uuid,date-time,uri,ipv4등과 같은 유력한 값을 생성합니다. - 부동산 이름에서 힌트를 얻을 수 있습니다. 그래서
name,price또는createdAt는 현실적으로 보입니다. $ref,allOf,oneOf및anyOf가 해결됩니다. 재귀 참조는 안전하게 끊어집니다.- 모크는 연산에 따라 결정적이기 때문에 각 리프레시에서 변하지 않습니다.
생성된 클라이언트를 사용
클라이언트는 BASE_URL 상수와 하나의 비동기 함수를 작업당 operationId (또는 입력된 경로 매개 변수, 질의 매개 변수 및 요청 본체) 를 입력하여 입력된 응답을 반환하여 이름 붙여서 수출합니다. fetch에만 의존해서, 브라우저, 노드 18+, 데노, 번에서 작동합니다.