Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация
Создавайте и проверяйте спецификации OpenAPI без написания кода с помощью редактора спецификаций.
Как открыть редактор спецификаций
Откройте спецификацию OpenAPI в редакторе спецификаций, как описано в следующих разделах:
- Как создать спецификацию OpenAPI
- Как импортировать спецификацию OpenAPI
- Как изменить существующую спецификацию OpenAPI
На рисунке ниже показана спецификация Petstore API, открытая в редакторе спецификаций:
Как показано на рисунке выше, редактор спецификаций позволяет:
- Создайте спецификацию OpenAPI для моделирования API в формате JSON или YAML на панели слева.
- В правой части экрана появится автоматически созданная документация по API.
- Проверяйте спецификацию на соответствие стандарту OpenAPI Specification по мере ее ввода.
- Сохраните спецификацию OpenAPI или закройте ее, отменив изменения.
Помощь с JSON и YAML
JSON (JavaScript Object Notation) – это легкий формат обмена данными, который используется для представления простых структур данных и ассоциативных массивов. Подробнее: https://www.json.org.
YAML (YAML Ain't Markup Language) – это стандарт сериализации и представления данных, который предоставляет синтаксис, сопоставимый со структурами данных, такими как списки, ассоциативные массивы и скаляры. Подробнее: https://yaml.org.
Оба формата удобны для чтения и понимания как для людей, так и для машин. На рисунке ниже сравниваются два коротких фрагмента одной и той же спецификации OpenAPI, написанной с использованием JSON и YAML:
Как проверить спецификацию
Редактор спецификаций проверяет спецификацию OpenAPI на соответствие стандарту спецификации OpenAPI. Если в спецификации OpenAPI есть ошибки, при вводе текста в редакторе спецификаций в верхней части правой панели появится диалоговое окно "Ошибка" с информацией об ошибках и номерами строк, в которых они допущены.
Как сохранить спецификацию
Чтобы сохранить спецификацию OpenAPI, нажмите Сохранить на панели навигации вверху страницы.
Если вы сохраняете спецификацию впервые, вам будет предложено ввести имя файла. Если вы не укажете название файла, по умолчанию будет использоваться вариант "Без названия". Вы сможете переименовать его позже.
Как закрыть спецификацию
Чтобы закрыть спецификацию OpenAPI без сохранения изменений, нажмите Отменить на панели навигации вверху страницы. Вы вернетесь к списку спецификаций.