Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация
Создавайте и проверяйте спецификации OpenAPI без написания кода с помощью редактора спецификаций.
Доступ к редактору спецификаций
Откройте спецификацию OpenAPI в редакторе спецификаций, как описано в следующих разделах:
- Создайте новую спецификацию OpenAPI.
- Импортируйте спецификацию OpenAPI
- Редактировать существующую спецификацию OpenAPI
На следующем рисунке показана спецификация API Petstore, открытая в редакторе спецификаций:
Как показано на предыдущем рисунке, редактор спецификаций позволяет:
- Создайте спецификацию OpenAPI для моделирования вашего API с использованием формата JSON или YAML на левой панели.
- Просмотрите автоматически созданную документацию по API на правой панели.
- Проверяйте свою спецификацию на соответствие стандарту спецификации OpenAPI по мере ввода.
- Сохраните спецификацию OpenAPI или закройте спецификацию и отмените изменения.
Помогите мне с JSON и YAML.
JSON (нотация объектов JavaScript) — это облегченный формат обмена данными, используемый для представления простых структур данных и ассоциативных массивов. Чтобы узнать больше, посетите https://www.json.org .
YAML (YAML не является языком разметки) — это стандарт сериализации/представления данных, который предоставляет синтаксис, который также предоставляет синтаксис, который можно сопоставить со структурами данных, такими как списки, ассоциативные массивы и скаляры. Чтобы узнать больше, посетите https://yaml.org .
И JSON, и YAML машиночитаемы, но их также легко читать и понимать людям. На следующем рисунке сравниваются два коротких отрывка из одной и той же спецификации OpenAPI, написанной с использованием JSON и YAML:
Проверка спецификации
Редактор спецификаций проверяет вашу спецификацию OpenAPI на соответствие стандарту спецификации OpenAPI. Если при вводе текста в спецификации OpenAPI есть ошибки, редактор спецификаций отображает диалоговое окно «Ошибка» в верхней части правой панели и предоставляет дополнительную информацию об ошибках и связанных с ними номерах строк, чтобы вы могли легко их исправить.
Сохранить спецификацию
Чтобы сохранить спецификацию OpenAPI, нажмите «Сохранить» на верхней панели навигации.
Если вы сохраняете спецификацию впервые, вам будет предложено ввести имя файла. Если вы не укажете имя файла, по умолчанию оно будет «Без названия». Вы можете переименовать его позже.
Закрыть спецификацию
Чтобы закрыть спецификацию OpenAPI без сохранения изменений, нажмите «Отмена» на верхней панели навигации. Вы вернетесь к списку спецификаций.