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