RAML
RAML(RESTful API Modeling Language)은 RESTful API에 대해 설명하는 YAML 기반 언어입니다. 또한 RAML은 RESTful API를 광범위하게 문서화하기 위한 기능을 제공하고 사용자 문서를 추출한 다음 PDF, HTML 등의 시각적 형식으로 변환하기 위한 문서 생성기 도구를 지원합니다.
RAML 작업을 사용하여 API에 액세스하고 RAML를 사용하여 API가 작성되는 서비스에 대한 API 호출을 만듭니다. RAML 작업은 RAML 사양 버전 0.8을 지원합니다.
워크플로에서 RAML 작업을 사용하려면 다음 단계를 완료합니다.
1. 을 클릭하고 API 설계에 있는 RAML 작업을 캔버스에 끌어 놓고 마우스 포인터로 작업을 가리킨 다음 을 클릭하거나 작업을 두 번 클릭합니다. RAML 창이 열립니다.
2. 필요한 경우 레이블을 편집합니다. 기본적으로 레이블 이름은 작업 이름과 동일합니다.
3. 루트 파일 URL 필드에 루트 RAML 파일 및 해당 종속성을 포함하는 zip 파일을 가져올 URL을 입력합니다.
4. 루트 파일 이름 필드에 가져올 RAML 루트 파일의 이름을 입력합니다.
5. 가져오기를 클릭하여 RAML 파일에 정의된 모든 API를 가져옵니다.
API 요청 목록은 RAML 파일에 정의된 API 목록을 제공합니다.
6. API 요청 목록에서 API를 선택합니다.
선택한 API에 따라 추가 세부 정보를 제공해야 할 수도 있습니다.
7. 완료를 클릭합니다.
출력 스키마
도움이 되셨나요?