Управляйте своими спецификациями

Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info

Apigee Edge предоставляет вам место для хранения спецификаций OpenAPI. Управление спецификациями OpenAPI осуществляется в соответствии с описанием в следующих разделах.

Для получения дополнительной информации о спецификациях OpenAPI см. раздел «Что такое спецификация OpenAPI?».

Ознакомьтесь со списком технических характеристик.

Чтобы получить доступ к списку технических характеристик:

1. Войдите на сайт apigee.com/edge .
2. Выберите организацию.
3. В боковом навигационном меню выберите «Разработка» > «Характеристики» .

Отображается текущий список характеристик и папок.

Как показано на предыдущем рисунке, из списка технических характеристик вы можете:

• Создание и импорт спецификаций
• Создайте API-прокси на основе спецификации с помощью многошагового мастера.
• Организуйте свои спецификации с помощью папок и перемещайтесь по этим папкам (см. раздел «Организация контента с помощью папок »).
• Отредактируйте спецификацию или откройте папку, щелкнув по строке.
• Переименовать или удалить спецификацию
• Просмотрите список технических характеристик и папок.

Создайте новую спецификацию OpenAPI.

Для создания новой спецификации OpenAPI:

1. В боковой панели навигации нажмите «Разработка» > «Характеристики» .
2. Click + Spec .
3. В выпадающем меню выберите пункт «Новая спецификация» . Откроется редактор спецификаций.
4. Замените пример спецификации на собственные подробные сведения из спецификации OpenAPI.
   См. раздел «Создание спецификаций с помощью редактора спецификаций» .
5. Нажмите «Сохранить» , чтобы сохранить спецификацию.
6. При появлении соответствующего запроса введите название для спецификации.
7. Нажмите « Сохранить ».

Импорт спецификации OpenAPI

Для импорта спецификации OpenAPI:

1. В боковой панели навигации нажмите «Разработка» > «Характеристики» .
2. Click + Spec .
3. Выберите один из следующих вариантов в выпадающем меню:
   • Для импорта спецификации по URL-адресу укажите имя и URL-адрес.
   • Импортируйте файл , чтобы найти спецификацию в локальной директории.
     Данная спецификация добавлена ​​в список.
4. Щелкните по названию спецификации, чтобы просмотреть и отредактировать ее в редакторе спецификаций.
   См. раздел «Создание спецификаций с помощью редактора спецификаций» .

Редактирование существующей спецификации OpenAPI

Чтобы открыть существующую спецификацию OpenAPI:

1. В боковой панели навигации нажмите «Разработка» > «Характеристики» .
2. Щелкните по строке, соответствующей спецификации, в списке спецификаций.
3. Отредактируйте спецификацию в редакторе спецификаций.
   См. раздел «Создание спецификаций с помощью редактора спецификаций» .

Создайте API-прокси на основе спецификации из списка спецификаций.

С помощью Apigee Edge вы можете создавать API-прокси на основе спецификаций OpenAPI, которые вы разрабатываете и сохраняете в редакторе спецификаций. Всего за несколько кликов вы получите API-прокси в Apigee Edge с автоматически сгенерированными путями, параметрами, условными потоками и целевыми конечными точками. Затем вы можете добавить такие функции, как безопасность OAuth, ограничение скорости запросов и кэширование.

После создания API-прокси на основе спецификации OpenAPI, если спецификация будет изменена, вам потребуется вручную изменить API-прокси, чтобы отразить внесенные изменения. См. раздел «Что произойдет, если я изменю спецификацию?» .

Чтобы создать API-прокси на основе спецификации OpenAPI из списка спецификаций:

1. В боковом навигационном меню выберите «Разработка» > «Характеристики» .
2. При необходимости перейдите в папку, содержащую спецификацию OpenAPI.
3. Наведите курсор на спецификацию OpenAPI, для которой вы хотите создать прокси-сервер API, чтобы отобразить меню действий.
4. Нажмите Открывается мастер создания прокси-сервера, и страница с подробными сведениями о прокси-сервере заполняется значениями из спецификации OpenAPI, как показано на следующем рисунке.
   
5. Нажмите «Далее» .
6. Пройдите оставшиеся страницы мастера создания прокси, как описано в разделе «Создание API-прокси на основе спецификации OpenAPI» . (Начните с шага 8.)

Переименовать спецификацию

Чтобы переименовать спецификацию:

1. В боковом навигационном меню выберите «Разработка» > «Характеристики» .
2. При необходимости перейдите в папку, содержащую спецификацию.
3. Наведите курсор на спецификацию, которую хотите переименовать, чтобы отобразить меню действий.
4. Нажмите .
5. Измените название спецификации.
6. Нажмите «Переименовать» , чтобы сохранить изменения, или «Отмена» , чтобы отменить.

Переместить спецификацию в папку

Для упрощения управления и обеспечения безопасности вы можете организовать свои спецификации в папки. Чтобы переместить спецификацию в папку, см. раздел «Организация спецификаций с помощью папок» .

Удалить спецификацию

Вы можете удалить спецификацию из хранилища файлов, когда она больше не нужна или становится недействительной.

Чтобы удалить спецификацию:

1. В боковом навигационном меню выберите «Разработка» > «Характеристики» .
2. Наведите курсор на параметр, который хотите удалить, чтобы отобразить меню действий.
3. Нажмите .
4. Нажмите кнопку «Удалить» для подтверждения операции удаления в появившемся окне.
5. Удалите связанные артефакты, которые больше не нужны.