Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info
Создавайте и проверяйте спецификации OpenAPI без написания кода, используя редактор спецификаций.
Получите доступ к редактору спецификаций.
Откройте спецификацию OpenAPI в редакторе спецификаций, как описано в следующих разделах:
- Создайте новую спецификацию OpenAPI.
- Импорт спецификации OpenAPI
- Редактирование существующей спецификации OpenAPI
На следующем рисунке показана спецификация API Petstore, открытая в редакторе спецификаций:
Как показано на предыдущем рисунке, редактор спецификаций позволяет вам:
- Создайте спецификацию 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 .
И JSON, и YAML читаются машинным способом, но при этом легко читаются и понимаются человеком. На следующем рисунке сравниваются два коротких фрагмента одной и той же спецификации OpenAPI, написанные с использованием JSON и YAML:
Проверить спецификацию
Редактор спецификаций проверяет вашу спецификацию OpenAPI на соответствие стандарту OpenAPI Specification. Если во время ввода текста в вашей спецификации OpenAPI обнаружены ошибки, редактор спецификаций отображает диалоговое окно «Ошибка» в верхней части правой панели и предоставляет дополнительную информацию об ошибках и соответствующих номерах строк, чтобы вы могли легко их исправить.
Сохранить спецификацию
Чтобы сохранить спецификацию OpenAPI, нажмите кнопку «Сохранить» в верхней панели навигации.
Если вы сохраняете спецификацию впервые, вам будет предложено ввести имя файла. Если вы не укажете имя файла, по умолчанию будет установлено имя «Без названия». Вы можете переименовать его позже.
Закрыть спецификацию
Чтобы закрыть спецификацию OpenAPI без сохранения изменений, нажмите кнопку «Отмена» в верхней панели навигации. Вы вернетесь к списку спецификаций.