Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация
Apigee Edge предоставляет вам место для хранения ваших спецификаций OpenAPI. Управляйте спецификациями 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 на основе спецификации OpenAPI . (Начните с шага 8.)
Переименование спецификации
Чтобы переименовать спецификацию:
- Выберите «Разработка» > «Спецификации» в боковом меню навигации.
- При необходимости перейдите к папке, содержащей спецификацию.
- Наведите курсор на спецификацию, которую вы хотите переименовать, чтобы отобразить меню действий.
- Нажмите .
- Отредактируйте имя спецификации.
- Нажмите «Переименовать» , чтобы сохранить изменения, или «Отмена» , чтобы отменить.
Переместить спецификацию в папку
Вы можете организовать свои спецификации в папки для облегчения управления и обеспечения безопасности. Чтобы переместить спецификацию в папку, см. раздел Организация спецификаций с помощью папок .
Удаление спецификации
Вы можете удалить спецификацию из хранилища файлов, когда она больше не нужна или становится недействительной.
Чтобы удалить спецификацию:
- Выберите «Разработка» > «Спецификации» в боковом меню навигации.
- Наведите курсор на спецификацию, которую вы хотите удалить, чтобы отобразить меню действий.
- Нажмите .
- Нажмите «Удалить» , чтобы подтвердить операцию удаления по запросу.
- Удалите связанные артефакты, которые больше не нужны.