API Blueprint 문서 가져오기
API Blueprint는 확장된 Markdown으로 API를 기술합니다. Restorm은 공식 파서인 Drafter를 WebAssembly로 컴파일해 내장하고 있으므로, 외부 도구는 전혀 필요하지 않습니다.
파일 ▸ 가져오기 (Ctrl+I) 를 열고 .apib 파일을 선택하거나,
FORMAT: 1A 로 시작하는 내용을 붙여넣으십시오.
가져오는 항목
Section titled “가져오는 항목”| 요소 | Restorm의 처리 방식 |
|---|---|
| 리소스 그룹 | 폴더 |
| 각 트랜지션 | HTTP 요청 |
| 파라미터 | 유형이 지정된 상태 |
| 서버 URL | 환경의 기본 URL |
| 설명과 모델 | API 문서 |
트랜지션 하나에 여러 예시가 있는 경우
Section titled “트랜지션 하나에 여러 예시가 있는 경우”API Blueprint의 트랜지션 하나는 여러 개의 + Request / + Response 쌍을 선언할
수 있습니다. Restorm은 쌍마다 요청을 하나씩 만들고, 서로 구분할 수 있도록
색인 접미사 (#1, #2 …)를 붙입니다.