API 가져오기

Restorm은 24 가지 형식을 인식하고, 그 형식으로부터 완전한 프로젝트 트리를 다시 만들어 냅니다. 폴더, 요청, 환경, API 문서, 열거형이 한꺼번에 생성됩니다.

거의 언제나 이 방법이 가장 좋은 출발점입니다. 명세가 이미 존재한다면 요청을 손으로 작성하지 마십시오.

가져오는 방법

파일 ▸ 가져오기 (Ctrl+I) 는 다음을 모두 받아들입니다.

• 디스크에 있는 파일
• URL — 온라인으로 제공되는 swagger.json 이나 $metadata 에 유용합니다.
• 붙여넣은 내용 — curl 명령을 요청으로 바꿀 때 쓰는 방법입니다.

Restorm은 형식을 스스로 판별합니다. 먼저 파일 확장자를 보고, 그다음 내용을 분석합니다. 따로 고를 것이 없습니다.

지원 형식

API 명세

형식	페이지
OpenAPI 3.x 및 Swagger 2.0	OpenAPI / Swagger
GraphQL 스키마 (SDL)	GraphQL
.proto 파일 및 gRPC 리플렉션	gRPC
WSDL	SOAP / WSDL
AsyncAPI	AsyncAPI
OData EDMX / CSDL	OData
OpenRPC	OpenRPC
tRPC 스키마	tRPC
Smithy	Smithy
TypeSpec	TypeSpec
RAML	RAML
WADL	WADL
Thrift	Thrift
API Blueprint	API Blueprint

다른 클라이언트의 컬렉션

형식	페이지
Postman	Postman
Insomnia	Insomnia
Bruno	Bruno
Thunder Client	Thunder Client
Paw / RapidAPI	Paw
HTTPie	HTTPie
VS Code REST Client (.http)	REST Client

캡처와 명령줄

형식	페이지
HAR (브라우저 캡처)	HAR
curl 명령	cURL
Invoke-RestMethod / Invoke-WebRequest	PowerShell

무엇을 얻게 되는가

원본 형식이 담고 있는 정보의 풍부함에 따라 다음이 만들어집니다.

• 하나 이상의 환경을 담은 변수 폴더. 기본 URL은 명세에서 추출됩니다.
• 폴더 트리 — 형식에 따라 태그별, 서비스별, 리소스별로 나뉩니다.
• 작업 하나당 요청 하나. 프로토콜에 맞는 종류로 생성됩니다.
• 폴더에 첨부되는 API 문서: 모델, 설명, 보안 스키마, 응답 예시
• 명세에 정의된 열거형. 값의 유형으로 다시 사용할 수 있습니다.
• 변수와 함께 미리 연결된 인증 헤더 — 인증을 참고하십시오.

가져오기가 끝나면 값이 빈 값으로 해석되는 키 / 값 쌍은 자동으로 비활성화됩니다. 따라서 첫 전송에서 빈 헤더가 무더기로 함께 나가는 일은 없습니다.

가져온 API의 문서

가져오기는 요청만 만들어 내는 것이 아닙니다. API의 문서, 즉 설명, 모델, 보안, 예시, 열거형까지 그대로 보존하며, 생성된 폴더의 문서 탭에서 확인할 수 있습니다. 가져온 API 문서 열람 및 업데이트를 참고하십시오.

가져온 결과 업데이트하기

12 가지 형식은 재동기화를 지원합니다. Restorm은 원본의 새 버전을 기존 트리와 비교해 차이만 적용하므로, 직접 수정한 내용은 사라지지 않습니다. 원본에서 업데이트하기를 참고하십시오.

내보내기는 어떻게 하나

Restorm은 각 요청에 대해 해당 프로토콜과 관련된 모든 언어의 코드 스니펫을 생성합니다. 코드 내보내기를 참고하십시오.