원본에서 업데이트하기

API 명세는 계속 변합니다. 전부 덮어쓰면서 다시 가져오면 직접 조정한 내용이 사라지고, 옆에 새로 가져오면 중복이 생깁니다. Restorm은 세 번째 방법을 씁니다. 차이를 계산하는 것입니다.

동작 방식

가져오기가 성공할 때마다 생성된 변수 폴더에 원본의 지문이 기록됩니다. 폴더의 새로 고침 버튼은 원본을 다시 가져와 지문을 비교하고, 처음부터 다시 만드는 대신 달라진 점만 적용합니다.

• 새 작업은 새로 가져왔다면 놓였을 위치에 추가됩니다.
• 변경된 작업은 명세가 추가한 내용만큼 파라미터가 보강됩니다.
• 명세가 더 이상 사용되지 않음으로 표시한 작업 에는 표시가 붙고 트리에서 흐리게 나타납니다.
• 원본에서 사라진 작업은 삭제된 것으로 표시되어 취소선이 그어지지만, 계속 실행할 수 있고 절대 삭제되지 않습니다.
• 직접 수정한 내용은 보존됩니다. 이름, 메서드, URL, 입력한 값은 절대 덮어쓰지 않습니다.

원칙은 이렇습니다. 명세는 자신이 기술하는 범위에 대해 권위를 가지고, 그 밖의 모든 것에 대해서는 사용자에게 권위가 있습니다.

버튼의 위치, 적용 전에 마법사가 보여 주는 내용, 문서에 일어나는 일까지 전체 흐름은 가져온 API 문서 열람 및 업데이트에 설명되어 있습니다.

URL로 가져온 경우에만

재동기화는 Restorm이 원본을 알고 있다는 전제에서 동작합니다. 원본이 기록되는 것은 URL에서 가져온 경우뿐입니다. 파일에서 가져오거나 붙여넣기로 가져온 경우에는 아래 목록에 형식이 들어 있어도 재동기화할 수 없습니다.

재동기화가 가능한 형식

해당하는 형식은 12 가지입니다.

• OpenAPI 3.x
• Swagger 2.0 (앞의 항목과 같은 페이지이지만 여기서는 따로 셈했습니다. 둘은 각각 고유한 재동기화 로직을 가지고 있습니다)
• GraphQL (SDL)
• gRPC — .proto 파일 과 서버 리플렉션 모두
• SOAP / WSDL
• OData
• AsyncAPI
• Postman
• Insomnia
• Bruno
• OpenRPC
• Smithy

재동기화가 불가능한 형식

HAR, cURL, PowerShell, REST Client, Thunder Client, Paw, HTTPie, RAML, WADL, Thrift, TypeSpec, API Blueprint, tRPC.

이 형식들은 다시 가져오면 새 트리가 만들어집니다. 두 트리를 직접 맞춰 보거나, 별도의 폴더로 가져오십시오.

특수한 경우: 리플렉션으로 가져온 gRPC

리플렉션으로 가져온 gRPC 요청에는 해당 탭에 바로 reflection에서 새로고침 버튼이 붙습니다. 개발 도중에 서비스가 계속 바뀔 때 가장 빠른 방법입니다.