OpenAPI / Swagger 가져오기

Restorm에서 가장 완성도가 높은 가져오기입니다. Swagger 2.0, OpenAPI 3.0, OpenAPI 3.1 세 가지 버전을 인식합니다.

가져오기

파일 ▸ 가져오기 (Ctrl+I) 를 열고 swagger.json / openapi.json 파일을 지정하거나, 명세의 URL을 바로 입력하십시오.

URL이 401 또는 403 을 반환하면, Restorm은 가져오기 모달을 벗어나지 않고 인증을 첨부해 다시 시도하도록 안내합니다.

가져오는 항목

명세의 요소	Restorm의 처리 방식
servers (또는 host + basePath + schemes)	환경의 기본 URL. 서버 변수는 해석된 상태입니다
tags	태그마다 폴더 하나, 그리고 나머지를 담는 Other 폴더
각 작업	메서드와 경로를 포함한 HTTP 요청
파라미터	경로 파라미터, 쿼리 파라미터, 헤더. 모두 유형이 지정됩니다 (문자열, 숫자, 날짜와 시간, 열거형, 비밀 값 등)
requestBody	해당 콘텐츠 유형의 본문
examples	제공된 예시로 미리 채워진 본문
components / definitions	API 문서: 모델과 설명
enum	값의 유형으로 다시 쓸 수 있는 열거형
응답	콘텐츠 유형별로 문서화됩니다

$ref 는 컴포넌트를 거치는 경우까지 모두 해석됩니다.

components / definitions 항목은 특히 짚어 둘 만합니다. 가져오기는 요청에만 그치지 않고 API 문서 전체, 즉 설명, 모델, 보안 스키마, 예시, 열거형까지 보존합니다. 이 문서는 가져오기로 만들어진 변수 폴더의 문서 탭에서도, 각 요청의 문서 탭에서도 볼 수 있고 원본에서 다시 동기화됩니다. 가져온 API 문서 열람 및 업데이트를 참고하십시오.

보안

선언된 보안 스키마는 미리 연결된 헤더나 파라미터로 변환되며, 그에 대응하는 환경 변수도 함께 만들어집니다.

스키마	Restorm이 설정하는 내용
헤더 또는 쿼리로 전달되는 apiKey	스키마 이름을 딴 키 / 값 쌍, 값은 {{<schema>}}
http + basic	Authorization: Basic {{<schema>_credentials}}
http + bearer, oauth2, openIdConnect	Authorization: Bearer {{<schema>_token}}

남은 일은 변수 값을 채우는 것뿐입니다. 또는 자동 갱신까지 누리려면 변수를 인증 경로로 바꾸십시오.

알려진 제약 사항

쿠키로 전달되는 apiKey 는 미리 연결되지 않습니다 (OpenAPI 3). 참조되었지만 선언되지 않은 보안 스키마는 조용히 무시됩니다.

업데이트하기

OpenAPI와 Swagger는 재동기화가 가능한 형식에 포함됩니다. 폴더의 새로 고침 버튼이 원본을 다시 가져오고 Restorm이 차이를 적용합니다. 새 작업은 추가되고, 사라진 작업은 삭제되는 대신 더 이상 사용되지 않음으로 표시되며, 직접 수정한 내용은 그대로 보존됩니다. 원본에서 업데이트하기를 참고하십시오.