Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация
В Apigee Edge можно хранить спецификации OpenAPI. Управление спецификациями OpenAPI описано в следующих разделах:
Подробнее о спецификации OpenAPI…
Как посмотреть список характеристик
Чтобы открыть список спецификаций:
- Войдите в аккаунт на сайте apigee.com/edge.
- Выберите организацию.
- В меню навигации слева выберите Разработка > Спецификации.
Появится текущий список спецификаций и папок.
Как показано на предыдущем рисунке, в списке спецификаций можно:
- Создание и импорт спецификаций
- Создайте прокси-сервер API на основе спецификации с помощью многоэтапного мастера.
- Упорядочивать спецификации с помощью папок и перемещаться между ними (см. раздел Как упорядочить контент с помощью папок).
- Изменить спецификацию или открыть папку, нажав на строку.
- Переименовать или удалить спецификацию.
- Поиск в списке спецификаций и папок
Как создать спецификацию OpenAPI
Чтобы создать спецификацию OpenAPI:
- На боковой панели навигации нажмите Разработка > Спецификации.
- Нажмите + Спецификация.
- В раскрывающемся меню нажмите Новая спецификация. Откроется редактор спецификаций.
- Замените пример спецификации на свою спецификацию OpenAPI.
Подробнее о том, как создавать спецификации с помощью редактора спецификаций… - Нажмите Сохранить.
- Введите название спецификации, когда будет предложено.
- Нажмите Сохранить.
Как импортировать спецификацию OpenAPI
Чтобы импортировать спецификацию OpenAPI:
- На боковой панели навигации нажмите Разработка > Спецификации.
- Нажмите + Спецификация.
- Выберите один из следующих вариантов в раскрывающемся меню:
- Импортировать URL, чтобы импортировать спецификацию из URL. Укажите название и URL.
- Нажмите Импортировать файл, чтобы найти спецификацию в локальном каталоге.
Спецификация будет добавлена в список.
- Нажмите на название спецификации, чтобы посмотреть и изменить ее в редакторе.
Подробнее о том, как создавать спецификации с помощью редактора спецификаций…
Как изменить существующую спецификацию OpenAPI
…Чтобы открыть существующую спецификацию OpenAPI:
- На боковой панели навигации нажмите Разработка > Спецификации.
- Нажмите на строку, связанную со спецификацией, в списке спецификаций.
- Измените спецификацию в редакторе спецификаций.
Подробнее о том, как создавать спецификации с помощью редактора спецификаций…
Как создать прокси-сервер API на основе спецификации из списка спецификаций
В Apigee Edge можно создавать прокси API на основе спецификаций OpenAPI, которые вы разрабатываете и сохраняете в редакторе спецификаций. Всего за несколько кликов вы создадите прокси-сервер API в Apigee Edge с автоматически сгенерированными путями, параметрами, условными потоками и целевыми конечными точками. Затем вы можете добавить такие функции, как безопасность OAuth, ограничение частоты запросов и кеширование.
Если вы создали прокси-сервер API на основе спецификации OpenAPI и затем изменили эту спецификацию, вам нужно будет вручную изменить прокси-сервер API, чтобы отразить внесенные изменения. Подробнее о том, что произойдет, если изменить спецификацию…
Чтобы создать прокси-сервер API на основе спецификации OpenAPI из списка спецификаций:
- В меню навигации слева выберите Разработка > Спецификации.
- При необходимости перейдите в папку, содержащую спецификацию OpenAPI.
- Наведите курсор на спецификацию OpenAPI, для которой вы хотите создать прокси-сервер API, чтобы открыть меню действий.
- Нажмите
.
Откроется мастер создания прокси-сервера, и страница сведений о прокси-сервере будет предварительно заполнена значениями из спецификации OpenAPI, как показано на рисунке ниже.
- Нажмите Далее.
- Перейдите к остальным страницам мастера создания прокси-сервера API, как описано в разделе Создание прокси-сервера API на основе спецификации OpenAPI. (Начните с шага 8.)
Как переименовать спецификацию
Чтобы переименовать спецификацию:
- В меню навигации слева выберите Разработка > Спецификации.
- При необходимости перейдите в папку, в которой находится спецификация.
- Наведите курсор на спецификацию, которую хотите переименовать, чтобы открыть меню действий.
- Нажмите
. - Измените название спецификации.
- Нажмите Переименовать, чтобы сохранить изменения, или Отмена, чтобы отменить их.
Как переместить спецификацию в папку
Вы можете упорядочить спецификации по папкам, чтобы упростить управление и повысить безопасность. Чтобы переместить спецификацию в папку, ознакомьтесь со статьей Как упорядочить спецификации с помощью папок.
Как удалить спецификацию
Вы можете удалить спецификацию из хранилища файлов, если она больше не нужна или стала недействительной.
…Чтобы удалить спецификацию:
- В меню навигации слева выберите Разработка > Спецификации.
- Наведите курсор на спецификацию, которую хотите удалить, чтобы открыть меню действий.
- Нажмите
. - Нажмите Удалить, чтобы подтвердить удаление.
- Удалите ненужные связанные объекты.