현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동 정보
사양 편집기를 사용해 코드를 작성하지 않고도 OpenAPI 사양을 생성하고 검증할 수 있습니다.
사양 편집기 액세스
다음 섹션에 설명된 대로 사양 편집기에서 OpenAPI 사양을 엽니다.
다음 그림은 사양 편집기에서 열려 있는 Petstore API의 사양을 보여줍니다.
이전 그림에 강조 표시된 것처럼 사양 편집기를 통해 다음을 할 수 있습니다.
- 왼쪽 창에서 JSON 또는 YAML 형식을 사용하여 API를 모델링하는 OpenAPI 사양을 만듭니다.
- 오른쪽 창에서 자동 생성된 API 문서를 확인합니다.
- 입력하면서 OpenAPI 사양 표준에 따라 사양의 유효성을 검사합니다.
- OpenAPI 사양을 저장하거나 사양을 닫고 수정사항을 취소합니다.
JSON 및 YAML에 대한 도움말
JSON (JavaScript Object Notation)은 간단한 데이터 구조와 결합 배열을 나타내는 데 사용되는 경량 데이터 교환 형식입니다. 자세한 내용은 https://www.json.org를 참고하세요.
YAML (YAML Ain't Markup Language)은 데이터 직렬화/표현 표준으로, 목록, 연관 배열, 스칼라와 같이 데이터 구조에 매핑할 수 있는 문법도 제공합니다. 자세한 내용은 https://yaml.org를 참조하세요.
JSON과 YAML은 모두 머신이 읽을 수 있지만 사람이 읽고 이해하기도 쉽습니다. 다음 그림은 JSON과 YAML을 사용하여 작성된 동일한 OpenAPI 사양의 짧은 발췌문 2개를 비교한 것입니다.
사양 검증
사양 편집기는 OpenAPI 사양 표준을 기준으로 OpenAPI 사양의 유효성을 검사합니다. 입력할 때 OpenAPI 사양에 오류가 있으면 사양 편집기가 오른쪽 창 상단에 Error(오류) 대화상자를 표시하고 오류와 관련 행 번호에 대한 자세한 정보를 제공하므로 이를 쉽게 수정할 수 있습니다.
사양 저장
OpenAPI 사양을 저장하려면 상단 탐색 메뉴에서 저장을 클릭합니다.
사양을 처음 저장하는 경우에는 파일 이름을 입력하라는 메시지가 표시됩니다. 파일 이름을 지정하지 않으면 기본적으로 '제목 없음'으로 지정됩니다. 나중에 이름을 변경할 수 있습니다.
사양 닫기
수정사항을 저장하지 않고 OpenAPI 사양을 닫으려면 상단 탐색 메뉴에서 Cancel을 클릭합니다. 사양 목록으로 돌아갑니다.