Публикуйте свои API

пользовательский интерфейс

Чтобы просмотреть каталог API:

1. Выберите «Опубликовать» > «Порталы» и выберите свой портал.
2. Нажмите «Каталог API» на главной странице портала. Альтернативно вы можете выбрать каталог API в раскрывающемся меню портала на верхней панели навигации.

На вкладке API в каталоге API отображается список API, добавленных на ваш портал.

Как показано на предыдущем рисунке, вкладка API позволяет:

• Просмотрите подробную информацию об API, доступных на вашем портале.
• Добавьте API на свой портал
• Измените API на своем портале, выполнив одну или несколько из следующих задач:
  • Управляйте снимком документа, связанного с продуктом API, для обновления справочной документации API.
  • Опубликовать или отменить публикацию API на вашем портале
  • Управляйте видимостью API на вашем портале :
  • Управление URL-адресом обратного вызова для API
  • Управление изображением карты API
  • Пометьте API, используя категории
  • Отредактируйте название и описание API
• Удалите API с вашего портала
• Управляйте категориями, используемыми для обнаружения связанных API.
• Быстро выявляйте устаревшие или удаленные из хранилища спецификаций спецификации.
• Быстро выявляйте потерянные API, связанный с которыми продукт API был удален из Apigee Edge, и заново создайте продукт API или удалите API со своего портала.

завиток

Чтобы перечислить API :

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
    -H "Authorization: Bearer ACCESS_TOKEN"

Замените следующее:

• ORG_NAME с названием организации. Например, my-org .
• SITE_ID с именем портала в формате ORG_NAME-PORTAL_NAME , где ORG_NAME — это название организации, а PORTAL_NAME — это имя портала, преобразованное в нижний регистр, с удаленными пробелами и тире. Например, my-org-myportal .
• ACCESS_TOKEN с токеном аутентификации, используемым для доступа к API Apigee Edge. Дополнительные сведения об аутентификации и токенах см. в разделе Аутентификация доступа к Edge API .

Инструкции по использованию нумерации страниц в полезных данных ответа см. в разделе Примечания к разбивке на страницы .

Полезная нагрузка ответа:

{
  "status": "success",
  "message": "one page of apidocs returned",
  "data": [
    {
      "id": 622759,
      "siteId": "my-org-myportal",
      "title": "Test",
      "description": "",
      "published": false,
      "visibility": false,
      "apiId": "apiproducttest18",
      "apiProductName": "apiproduct_test18",
      "edgeAPIProductName": "apiproduct_test18",
      "specId": null,
      "specContent": null,
      "specTitle": null,
      "snapshotExists": false,
      "snapshotModified": null,
      "modified": 1724144471000,
      "anonAllowed": false,
      "imageUrl": null,
      "snapshotState": null,
      "requireCallbackUrl": false,
      "categoryIds": [],
      "specFormat": null,
      "specModified": null,
      "snapshotOutdated": false,
      "snapshotSourceMissing": false,
      "graphqlSchema": null,
      "graphqlEndpointUrl": null,
      "graphqlSchemaDisplayName": null,
      "grpcFileName": null,
      "grpcZipContent": null
    }
  ],
  "code": null,
  "request_id": "1452867334",
  "error_code": null,
  "next_page_token": ""
}

Где:

• modified : время последнего изменения элемента каталога в миллисекундах с момента начала. Например, 1698165480000 .
• id : идентификатор элемента каталога. Например, 399668 .

Примечания к страницам:

• Размер страницы : используйте pageSize , чтобы указать количество элементов списка, возвращаемых на одной странице. По умолчанию — 25, а максимальное — 100. Если есть дополнительные страницы, nextPageToken заполняется токеном:

  curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs?pageSize=PAGE_SIZE" \
     -H "Authorization: Bearer ACCESS_TOKEN"
  

  Заменять:

  • PAGE_SIZE — количество элементов списка, возвращаемых на одной странице. Например, 10.

  Полезная нагрузка ответа:

  {
    "status": "success",
    "message": "one page of apidocs returned",
    "data": [
      {
        "id": 638007,
        "siteId": "tsnow-mint-liztest",
        "title": "Testing",
        "description": "",
        "published": false,
        "visibility": false,
        "apiId": "testcatalog",
        "apiProductName": "testcatalog",
        "edgeAPIProductName": "testcatalog",
        "specId": "Petstore",
        "specContent": null,
        "specTitle": null,
        "snapshotExists": true,
        "snapshotModified": 1726508367000,
        "modified": 1728582504000,
        "anonAllowed": false,
        "imageUrl": null,
        "snapshotState": "OK_SUBMITTED",
        "requireCallbackUrl": false,
        "categoryIds": [],
        "specFormat": "YAML",
        "specModified": null,
        "snapshotOutdated": false,
        "snapshotSourceMissing": false,
        "graphqlSchema": null,
        "graphqlEndpointUrl": null,
        "graphqlSchemaDisplayName": null,
        "grpcFileName": null,
        "grpcZipContent": null
      }
    ],
    "code": null,
    "request_id": "1068810934",
    "error_code": null,
    "next_page_token": ""
  }
  

• Токен страницы : используйте pageToken для получения последующих страниц, если их несколько:

  curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs?pageSize=PAGE_SIZE&pageToken=PAGE_TOKEN" \
        -H "Authorization: Bearer ACCESS_TOKEN"
  

  Заменять:

  • PAGE_SIZE — количество элементов списка, возвращаемых на одной странице. Например, 10.
  • PAGE_TOKEN со значением nextPageToken . Например, 7zcqrin9l6xhi4nbrb9 .

пользовательский интерфейс

Чтобы добавить API на ваш портал:

1. Доступ к каталогу API .
2. Откройте вкладку API , если она еще не выбрана.

3. Нажмите + Добавить .

   Откроется диалоговое окно «Добавление продукта API в каталог» .

4. Выберите продукт API, который вы хотите добавить на свой портал.

5. Нажмите Далее . Откроется страница сведений об API .

6. Настройте содержимое справочной документации API и ее видимость на портале:

   Поле	Описание
   Опубликовано	Выберите Опубликовано , чтобы опубликовать API на вашем портале. Снимите флажок, если вы не готовы опубликовать API. Вы можете изменить этот параметр позже, как описано в разделе Публикация или отмена публикации API на вашем портале .
   Отображать заголовок	Обновите название вашего API, отображаемое в каталоге. По умолчанию используется имя продукта API. Вы можете изменить отображаемый заголовок позже, как описано в разделе «Редактирование отображаемого заголовка и описания» .
   Отображение описания	Обновите описание вашего API, отображаемое в каталоге. По умолчанию используется описание продукта API. Вы можете изменить описание отображения позже, как описано в разделе «Редактирование заголовка и описания отображения» .
   Требовать от разработчиков указания URL-адреса обратного вызова	Включите этот параметр, если вы хотите, чтобы разработчики приложений указывали URL-адрес обратного вызова . Вы можете добавить или обновить URL-адрес обратного вызова позже, как описано в разделе «Управление URL-адресом обратного вызова для API» .
   Документация по API	Чтобы использовать документ OpenAPI: Выберите документ OpenAPI . Нажмите «Выбрать документ» . Выполните один из следующих шагов: Перейдите на вкладку «Мои спецификации» и выберите спецификацию в хранилище спецификаций. Перейдите на вкладку «Загрузить файл» и загрузите файл. Перейдите на вкладку «Импорт из URL-адреса» и импортируйте спецификацию из URL-адреса. Нажмите «Выбрать» . Чтобы использовать схему GraphQL: Выберите схему GraphQL . Нажмите «Выбрать документ» . Перейдите и выберите схему GraphQL. Нажмите «Выбрать» . Альтернативно вы можете выбрать «Нет документации» и добавить ее позже, после добавления API, как описано в разделе «Управление снимком документа» .
   видимость API	Если вы не зарегистрировались в бета-версии функции управления аудиторией , выберите один из следующих вариантов: Анонимные пользователи , чтобы все пользователи могли просматривать API. Зарегистрированные пользователи , чтобы разрешить просмотр API только зарегистрированным пользователям. Если вы зарегистрировались для участия в бета-версии функции управления аудиторией , выберите один из следующих вариантов: Публичный (видимый всем), чтобы все пользователи могли просматривать API. Аутентифицированные пользователи , чтобы разрешить просмотр API только зарегистрированным пользователям. Выбранные аудитории , чтобы выбрать конкретные аудитории, которым вы хотите иметь возможность просматривать API. Управлять видимостью аудитории можно позже, как описано в разделе Управление видимостью API на портале .
   Показать изображение	Чтобы отобразить изображение на карточке API на странице API, нажмите «Выбрать изображение» . В диалоговом окне «Выбор изображения» выберите существующее изображение, загрузите новое изображение или укажите URL-адрес внешнего изображения и нажмите «Выбрать» . Просмотрите миниатюру API и нажмите «Выбрать» . Вы можете добавить изображение позже, как описано в разделе «Управление изображением для карты API» . При указании изображения с внешним URL-адресом изображение не будет загружено в ваши ресурсы; кроме того, загрузка изображения на интегрированном портале будет зависеть от его доступности, которая может быть заблокирована или ограничена политиками безопасности контента .
   Категории	Добавьте категории, к которым будет помечен API, чтобы разработчики приложений могли находить связанные API на странице API. Чтобы определить категорию: Выберите категорию из раскрывающегося списка. Добавьте новую категорию, введя ее имя и нажав Enter . Новая категория будет добавлена ​​на страницу «Категории» и станет доступной при добавлении или редактировании других API.

7. Нажмите Сохранить .

завиток

Чтобы добавить API на ваш портал:

curl -X POST "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
       "title": "TITLE",
       "description": "DESCRIPTION",
       "anonAllowed": ANON_TRUE_OR_FALSE,
       "imageUrl": "IMAGE_URL",
       "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
       "categoryIds": [
         "CATEGORY_ID1",
         "CATEGORY_ID2"
       ],
       "published": PUBLISHED_TRUE_OR_FALSE,
        "apiProductName": "API_PRODUCT"
    }'

Замените следующее:

• ORG_NAME с названием организации. Например, my-org .
• SITE_ID с именем портала в формате ORG_NAME-PORTAL_NAME , где ORG_NAME — это название организации, а PORTAL_NAME — это имя портала, преобразованное в нижний регистр, с удаленными пробелами и тире. Например, my-org-myportal .
• ACCESS_TOKEN с токеном аутентификации, используемым для доступа к API Apigee Edge. Дополнительные сведения об аутентификации и токенах см. в разделе Аутентификация доступа к Edge API .
• TITLE с отображаемым заголовком. Например, Hello World 2 .
• DESCRIPTION с описанием дисплея. Например, Simple hello world example .
• ANON_TRUE_OR_FALSE с true или false (по умолчанию), где true означает, что этот API общедоступен и его можно просматривать анонимно; в противном случае его смогут просматривать только зарегистрированные пользователи.
• IMAGE_URL с URL-адресом внешнего изображения, используемого для элемента каталога, или путем к файлам изображений, хранящимся на портале , например /files/book-tree.jpg . При указании URL-адреса внешнего изображения изображение не будет загружено в ваши ресурсы; кроме того, загрузка изображения на интегрированном портале будет зависеть от его доступности, которая может быть заблокирована или ограничена политиками безопасности контента .
• CALLBACK_TRUE_OR_FALSE с true или false (по умолчанию), где true требует от пользователя портала ввода URL-адреса при управлении приложением.
• CATEGORY_ID с идентификатором категории. Например, bf6505eb-2a0f-47af-a00a-ded40ac72960 . Разделяйте несколько идентификаторов категорий запятой. Получите идентификатор категории с помощью команды list API категории .
• PUBLISHED_TRUE_OR_FALSE с true или false (по умолчанию), где true указывает, что API общедоступен. После публикации вы можете разрешить доступ всем пользователям, прошедшим проверку подлинности пользователям или определенным пользователям.
• API_PRODUCT с названием продукта API. Например, Hello World 2 .

Полезная нагрузка ответа:

{
  "status": "success",
  "message": "API created",
  "data": {
    "id": 662423,
    "siteId": "my-org-myportal",
    "title": "My Test Catalog 4",
    "description": "",
    "published": false,
    "visibility": false,
    "apiId": "uxb9wjua",
    "apiProductName": "uXB9wJUa",
    "edgeAPIProductName": "uXB9wJUa",
    "specId": null,
    "specContent": null,
    "specTitle": null,
    "snapshotExists": false,
    "snapshotModified": null,
    "modified": 1729635493000,
    "anonAllowed": false,
    "imageUrl": null,
    "snapshotState": null,
    "requireCallbackUrl": false,
    "categoryIds": [],
    "specFormat": null,
    "specModified": null,
    "snapshotOutdated": null,
    "snapshotSourceMissing": false,
    "graphqlSchema": null,
    "graphqlEndpointUrl": null,
    "graphqlSchemaDisplayName": null,
    "grpcFileName": null,
    "grpcZipContent": null
  },
  "code": null,
  "request_id": "893346193",
  "error_code": null
}

Где:

• modified : время последнего изменения элемента каталога в миллисекундах с момента начала. Например, 1698165480000 .
• id : идентификатор элемента каталога. Например, 399668 .

пользовательский интерфейс

Чтобы отредактировать API:

1. Доступ к каталогу API .
2. Откройте вкладку API , если она еще не выбрана.
3. Щелкните строку API, который вы хотите изменить.
4. Нажмите Редактировать .
5. В разделе «Сведения об API» внесите любые изменения. См. описания параметров в разделе «Добавление API» .
6. Нажмите Сохранить .

завиток

Добавив API, используйте вызов обновления для внесения изменений.

В этом примере показаны шаги, необходимые для изменения опубликованного статуса вашего API на портале с true на false . При необходимости вы можете изменить несколько настроек за один вызов API.

1. Чтобы найти сгенерированный id , который однозначно идентифицирует каждый API, получите список API на своем портале, как описано в разделе «Изучение API» .

2. Верните текущие значения для определенного API :

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
   -H "Authorization: Bearer ACCESS_TOKEN"
   

   Замените следующее:

   • ORG_NAME с названием организации. Например, my-org .
   • SITE_ID с именем портала в формате ORG_NAME-PORTAL_NAME , где ORG_NAME — это название организации, а PORTAL_NAME — это имя портала, преобразованное в нижний регистр, с удаленными пробелами и тире. Например, my-org-myportal .
   • API_DOC со сгенерированным id документа. Например, 399668 . Используйте команду list API docs, чтобы найти это значение.
   • ACCESS_TOKEN с токеном аутентификации, используемым для доступа к API Apigee Edge. Дополнительные сведения об аутентификации и токенах см. в разделе Аутентификация доступа к Edge API .

   Полезная нагрузка ответа:

   {
     "status": "success",
     "message": "apidoc returned",
     "data": {
       "id": 662423,
       "siteId": "my-org-myportal",
       "title": "My Test Catalog 4",
       "description": "",
       "published": false,
       "visibility": false,
       "apiId": "uxb9wjua",
       "apiProductName": "uXB9wJUa",
       "edgeAPIProductName": "uXB9wJUa",
       "specId": null,
       "specContent": null,
       "specTitle": null,
       "snapshotExists": false,
       "snapshotModified": null,
       "modified": 1729635493000,
       "anonAllowed": false,
       "imageUrl": null,
       "snapshotState": null,
       "requireCallbackUrl": false,
       "categoryIds": [],
       "specFormat": null,
       "specModified": null,
       "snapshotOutdated": false,
       "snapshotSourceMissing": false,
       "graphqlSchema": null,
       "graphqlEndpointUrl": null,
       "graphqlSchemaDisplayName": null,
       "grpcFileName": null,
       "grpcZipContent": null
     },
     "code": null,
     "request_id": "601210268",
     "error_code": null
   }
   

1. Включите изменяемые значения, которые вы хотите сохранить в вызове обновления , и измените значения, которые хотите изменить. Если вы опустите строку, будет использована настройка по умолчанию. В этом примере измените опубликованный параметр с false на true :

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
       "title": "TITLE",
       "anonAllowed": true,
       "published": true
    }'
   

   Замените следующее:

   • TITLE с отображаемым заголовком. Например, Hello World 2 .

   Полезная нагрузка ответа:

   {
     "status": "success",
     "message": "ApiDoc updated",
     "data": {
       "id": 662423,
       "siteId": "my-org-myportal",
       "title": "My Test Catalog 4",
       "description": "",
       "published": true,
       "visibility": true,
       "apiId": "uxb9wjua",
       "apiProductName": "uXB9wJUa",
       "edgeAPIProductName": "uXB9wJUa",
       "specId": null,
       "specContent": null,
       "specTitle": null,
       "snapshotExists": false,
       "snapshotModified": null,
       "modified": 1729989250000,
       "anonAllowed": true,
       "imageUrl": null,
       "snapshotState": null,
       "requireCallbackUrl": false,
       "categoryIds": [],
       "specFormat": null,
       "specModified": null,
       "snapshotOutdated": null,
       "snapshotSourceMissing": false,
       "graphqlSchema": null,
       "graphqlEndpointUrl": null,
       "graphqlSchemaDisplayName": null,
       "grpcFileName": null,
       "grpcZipContent": null
     },
     "code": null,
     "request_id": "738172002",
     "error_code": null
   }
   

пользовательский интерфейс

Чтобы опубликовать или отменить публикацию API на вашем портале:

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

завиток

Включите в вызов обновления одно из следующих действий:

"published": true,    # API is published to your portal
"published": false,   # API is not published in your portal

Чтобы отредактировать API:

1. Вернуть текущие значения :

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
   -H "Authorization: Bearer ACCESS_TOKEN"

2. Используйте вызов обновления для редактирования API. Включите изменяемые значения, которые вы хотите сохранить, и измените значения, которые хотите изменить. Если вы опустите изменяемый параметр, он будет перезаписан значением по умолчанию.

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/  ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
       "title": "TITLE",
       "description": "DESCRIPTION",
       "anonAllowed": ANON_TRUE_OR_FALSE,
       "imageUrl": IMAGE_URL,
       "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
       "categoryIds": [
         "CATEGORY_ID1",
        "CATEGORY_ID2"
       ],
       "published": PUBLISHED_TRUE_OR_FALSE
   }

Подробный пример возвращаемых шагов, переменных и полезных данных см. в разделе Управление версией документа .

пользовательский интерфейс

Чтобы управлять видимостью API на вашем портале:

1. Доступ к каталогу API .
2. Откройте вкладку API , если она еще не выбрана.
3. Щелкните строку API, который вы хотите изменить.
4. Нажмите Редактировать .

5. Выберите настройку видимости. Если вы зарегистрировались для участия в бета-версии функции «Аудитории», выберите один из следующих вариантов:

   • Публичный (видимый всем), чтобы все пользователи могли просматривать страницу.
   • Аутентифицированные пользователи , чтобы разрешить просмотр страницы только зарегистрированным пользователям.
   • Выбранные аудитории , чтобы выбрать конкретные аудитории, которым вы хотите иметь возможность просматривать страницу. См. раздел Управление аудиторией вашего портала .
   В противном случае выберите один из следующих вариантов:
   • Анонимные пользователи , чтобы разрешить всем пользователям просматривать страницу.
   • Зарегистрированные пользователи , чтобы разрешить просмотр страницы только зарегистрированным пользователям.

6. Нажмите «Отправить» .

завиток

Если вы зарегистрировались в бета-версии функции управления аудиторией, используйте пользовательский интерфейс для управления аудиторией.

Если вы не зарегистрировались в функции управления аудиторией, видимость управляется с помощью anonAllowed .

Включите в вызов update одно из следующих действий:

  # When not enrolled in the beta release of the audience management feature:

  "anonAllowed": true,      # Anonymous users can see the API
  "anonAllowed": false,     # Only registered users can see the API

Чтобы отредактировать API:

1. Вернуть текущие значения :

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. Используйте вызов обновления для редактирования API. Включите изменяемые значения, которые вы хотите сохранить, и измените значения, которые хотите изменить. Если вы опустите изменяемый параметр, будет использовано значение по умолчанию.

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

Подробный пример возвращаемых шагов, переменных и полезных данных см. в разделе «Редактирование API».

пользовательский интерфейс

Чтобы управлять URL-адресом обратного вызова для API:

1. Доступ к каталогу API .
2. Откройте вкладку API , если она еще не выбрана.
3. Щелкните строку API, который вы хотите изменить.
4. Нажмите Редактировать .
5. В разделе «Сведения об API» установите или снимите флажок «Требовать от разработчиков указывать URL-адрес обратного вызова» .
6. Нажмите Сохранить .

завиток

Включите в вызов update одно из следующих действий:

  "requireCallbackUrl": true,    # Portal user is required to input a URL
  "requireCallbackUrl": false,   # Portal user is not required to input a URL

Чтобы отредактировать API:

1. Вернуть текущие значения :

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. Используйте вызов обновления для редактирования API. Включите изменяемые значения, которые вы хотите сохранить, и измените значения, которые хотите изменить. Если вы опустите изменяемый параметр, будет использовано значение по умолчанию.

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

Подробный пример возвращаемых шагов, переменных и полезных данных см. в разделе «Редактирование API».

пользовательский интерфейс

Чтобы управлять изображением карты API:

1. Доступ к каталогу API .
2. Откройте вкладку API , если она еще не выбрана.
3. Нажмите на строку API, который вы хотите изменить.
4. Нажмите Редактировать .

5. В деталях API :

   • Нажмите «Выбрать изображение» , чтобы указать или загрузить изображение, если изображение не выбрано.
   • Нажмите «Изменить изображение» , чтобы указать или загрузить другое изображение.
   • Нажмите x на изображении, чтобы удалить его.

   При указании изображения укажите либо изображение с внешним URL-адресом, используемым для элемента каталога, либо путь к файлам изображений, хранящимся на портале , например, /files/book-tree.jpg . При указании URL-адреса внешнего изображения изображение не будет загружено в ваши ресурсы; кроме того, загрузка изображения на интегрированном портале будет зависеть от его доступности, которая может быть заблокирована или ограничена политиками безопасности контента .

6. Нажмите Сохранить .

завиток

Включите в вызов update следующее:

  # Omit line for no image file

  "imageUrl": "IMAGE_URL"    # URL of the external image or name of the image file

Чтобы отредактировать API:

1. Вернуть текущие значения :

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. Используйте вызов обновления для редактирования API. Включите изменяемые значения, которые вы хотите сохранить, и измените значения, которые хотите изменить. Если вы опустите изменяемый параметр, будет использовано значение по умолчанию.

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

Подробный пример возвращаемых шагов, переменных и полезных данных см. в разделе «Редактирование API».

пользовательский интерфейс

Чтобы пометить API по категориям при редактировании API:

1. Доступ к каталогу API .
2. Откройте вкладку API , если она еще не выбрана.
3. Нажмите на строку API, который вы хотите изменить.
4. Нажмите Редактировать .
5. Нажмите в поле «Категории» и выполните одно из следующих действий:
   • Выберите категорию из раскрывающегося списка.
   • Добавьте новую категорию, введя ее имя и нажав Enter . Новая категория будет добавлена ​​на страницу «Категории» и станет доступной при добавлении или редактировании других API.
6. Повторите действия, чтобы пометить API для других категорий.
7. Нажмите Сохранить .

завиток

Включите в вызов update следующее:

  # Omit line for no categories

  "categoryIds": [
      "CATEGORY_ID1",      # A category ID number
      "CATEGORY_ID2"       # A category ID number
    ],

Используйте команду списка категорий , чтобы получить идентификационные номера категорий.

Чтобы отредактировать API:

1. Вернуть текущие значения :

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. Используйте вызов обновления для редактирования API. Включите изменяемые значения, которые вы хотите сохранить, и измените значения, которые хотите изменить. Если вы опустите изменяемый параметр, будет использовано значение по умолчанию.

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

Подробный пример возвращаемых шагов, переменных и полезных данных см. в разделе «Редактирование API».

пользовательский интерфейс

Чтобы отредактировать отображаемый заголовок и описание:

1. Доступ к каталогу API .
2. Откройте вкладку API , если она еще не выбрана.
3. Щелкните строку API, который вы хотите изменить.
4. Нажмите Редактировать .
5. При необходимости отредактируйте поля «Заголовок дисплея» и «Описание отображения» .
6. Нажмите Сохранить .

завиток

Включите в вызов update следующее:

  "title": "TITLE",    # Display title
  "description": "DESCRIPTION",  # Display description

Чтобы отредактировать API:

1. Вернуть текущие значения :

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. Используйте вызов обновления для редактирования API. Включите изменяемые значения, которые вы хотите сохранить, и измените значения, которые хотите изменить. Если вы опустите изменяемый параметр, будет использовано значение по умолчанию.

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

Подробный пример возвращаемых шагов, переменных и полезных данных см. в разделе «Редактирование API».

пользовательский интерфейс

Чтобы удалить API с вашего портала:

1. Доступ к каталогу API .
2. Выберите API , если они еще не выбраны.
3. Наведите курсор на API в списке, чтобы отобразить меню действий.
4. Нажмите Удалить .

завиток

Чтобы удалить API с вашего портала :

curl -X DELETE "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
    -H "Authorization: Bearer ACCESS_TOKEN"

Замените следующее:

• ORG_NAME с названием организации. Например, my-org .
• SITE_ID с именем портала в формате ORG_NAME-PORTAL_NAME , где ORG_NAME — это название организации, а PORTAL_NAME — это имя портала, преобразованное в нижний регистр, с удаленными пробелами и тире. Например, my-org-myportal .
• API_DOC со сгенерированным id документа. Например, 399668 . Используйте команду list API docs, чтобы найти это значение.
• ACCESS_TOKEN с токеном аутентификации, используемым для доступа к API Apigee Edge. Дополнительные сведения об аутентификации и токенах см. в разделе Аутентификация доступа к Edge API .

Полезная нагрузка ответа:

{
  "status": "success",
  "message": "Apidoc deleted",
  "data": {
  },
  "code": null,
  "request_id": "1790036484",
  "error_code": null
}

пользовательский интерфейс

1. Доступ к каталогу API .
2. Откройте вкладку API , если она еще не выбрана.
3. Щелкните строку API, который вы хотите изменить.
4. Проверьте состояние моментального снимка. Если дата устарела, отображается следующее сообщение:
5. Нажмите edit » .
6. Выполните одну из следующих задач:
   • Чтобы обновить снимок устаревшего документа OpenAPI, нажмите «Обновить снимок» .
   • Чтобы изменить документ, который используется для создания документации для API, в разделе «Документация API» нажмите «Выбрать документ» и выберите новый документ.
7. На панели документации API выберите один из следующих вариантов:
   • документ OpenAPI
   • Схема GraphQL
8. Нажмите «Выбрать документ» и выберите последнюю версию документа.
9. Для GraphQL укажите URL-адрес конечной точки .
10. Нажмите Сохранить .

Справочная документация API отображается из документа и добавляется на страницу справки по API. Статус моментального снимка обновляется до текущего:

завиток

Чтобы обновить содержимое документации OpenAPI или GraphQL :

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"oasDocumentation": {
           "spec":{ "displayName":"DISPLAY_NAME",
                    "contents":"CONTENTS"}
            }
        }'

{
 "status":"success",
 "message":"Api documentation updated",
 "requestId":"645138278"
 "data": {
   "oasDocumentation": {
     "spec": {
        "displayName": "Hello World 2"
      },
     "Format": "YAML"
   }
 }
}

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"graphqlDocumentation": {
         "schema":{"displayName":"DISPLAY_NAME",
         "contents":"CONTENTS"},
         "endpointUri": "ENDPOINT_URI"
          }
      }'

{
"status": "success",
"message": "ApiDocDocumentation updated",
"data": {
  "oasDocumentation": null,
  "graphqlDocumentation": {
    "schema": {
      "displayName": "schema.docs.graphql",
      "contents": ""
    },
    "endpointUri": "https://demo.google.com/graphql"
  }
},
"code": null,
"request_id": "640336173",
"error_code": null
}

пользовательский интерфейс

завиток

Для загрузки документации API с помощью документации :

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN"

Замените следующее:

• ORG_NAME с именем организации. Например, my-org .
• SITE_ID с именем портала, в форме ORG_NAME-PORTAL_NAME , где ORG_NAME является именем организации, а PORTAL_NAME -это имя портала, преобразованное во все строчные и снятые пробелы и тире. Например, my-org-myportal .

• API_DOC с сгенерированным id документа. Например, 399668 . Используйте команду DOCS DOCS List, чтобы найти это значение.

  Ответ полезная нагрузка:

{
  "status": "success",
  "message": "ApiDocDocumentation returned",
  "data": {
    "oasDocumentation": {
      "spec": {
        "displayName": "mock",
        "contents": "b3BlbmFwaTogMy4wLjAKaW5mbzoKICBkZXNjcmlw ..."
      },
      "format": "YAML"
    },
    "graphqlDocumentation": null
  },
  "code": null,
  "request_id": "269996898",
  "error_code": null
}

Где:

contents : кодируемая базовая 64 содержимое документации API.

пользовательский интерфейс

1. Доступ к каталогу API .
2. Нажмите на вкладку APIS , если не выбрано.
3. Нажмите в строке API, который вы хотите отредактировать.
4. Нажмите edit Edit .
5. На панели документации API выберите документацию .
6. Нажмите Сохранить .

завиток

Для очистки существующего контента используйте API обновления :

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{}'

Замените следующее:

• ORG_NAME с именем организации. Например, my-org .
• SITE_ID с именем портала, в форме ORG_NAME-PORTAL_NAME , где ORG_NAME является именем организации, а PORTAL_NAME -это имя портала, преобразованное во все строчные и снятые пробелы и тире. Например, my-org-myportal .
• API_DOC с сгенерированным id документа. Например, 399668 . Используйте команду DOCS DOCS List, чтобы найти это значение.

Ответ полезная нагрузка:

{
  "status": "success",
  "message": "ApiDocDocumentation updated",
  "data": {
    "oasDocumentation": null,
    "graphqlDocumentation": null
  },
  "code": null,
  "request_id": "304329676",
  "error_code": null
}

пользовательский интерфейс

Чтобы просмотреть страницу категорий:

1. Выберите «Опубликовать»> «Порталы» и выберите свой портал.
2. Нажмите на каталог API на домашней странице портала.

   В качестве альтернативы, вы можете выбрать каталог API в раскрывающемся меню портала в верхней навигационной панели.

3. Нажмите на вкладку «Категории» .

Вкладка «Категории» в каталоге API отображает список категорий, которые были определены для вашего портала.

Как показано на предыдущем рисунке, страница APIS позволяет вам:

• Посмотреть категории и API, на которые они помечены
• Добавить категорию
• Редактировать категорию
• Удалить категорию
• Управляйте API, опубликованными на вашем портале. См. Изучите каталог API

завиток

Чтобы перечислить категории :

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories" \
    -H "Authorization: Bearer ACCESS_TOKEN"

Замените следующее:

• ORG_NAME с именем организации. Например, my-org .
• SITE_ID с именем портала, в форме ORG_NAME-PORTAL_NAME , где ORG_NAME является именем организации, а PORTAL_NAME -это имя портала, преобразованное во все строчные и снятые пробелы и тире. Например, my-org-myportal .
• ACCESS_TOKEN с токеном аутентификации, используемом для доступа к API Apigee Edge. Для получения дополнительной информации об аутентификации и токенах см. Authenticate Access к Edge API .

Ответ полезная нагрузка:

{
  "status": "success",
  "message": "all ApiCategory items returned",
  "data": [
    {
      "id": "e0518597-ece2-4d7d-ba7c-d1793df0f8db",
      "siteId": "my-org-myportal",
      "name": "My Category"
    },
    {
      "id": "61c1014c-89c9-40e6-be3c-69cca3505620",
      "siteId": "my-org-myportal",
      "name": "test2"
    }
  ],
  "code": null,
  "request_id": "1263510680",
  "error_code": null
}

Где:

• id : идентификатор элемента категории. Например, 61c1014c-89c9-40e6-be3c-69cca3505620 .

пользовательский интерфейс

Чтобы вручную добавить категорию:

1. Доступ к странице категорий .
2. Нажмите + добавить .
3. Введите имя своей новой категории.
4. При желании выберите один или несколько API, чтобы пометить в категорию.
5. Нажмите Создать .

завиток

Чтобы добавить категорию :

curl -X POST "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "CATEGORY_NAME" }'

Замените следующее:

• ORG_NAME с именем организации. Например, my-org .
• SITE_ID с именем портала, в форме ORG_NAME-PORTAL_NAME , где ORG_NAME является именем организации, а PORTAL_NAME -это имя портала, преобразованное во все строчные и снятые пробелы и тире. Например, my-org-myportal .
• ACCESS_TOKEN с токеном аутентификации, используемом для доступа к API Apigee Edge. Для получения дополнительной информации об аутентификации и токенах см. Authenticate Access к Edge API .
• CATEGORY_NAME с именем категории. Например, demo-backend .

Ответ полезная нагрузка:

{
  "status": "success",
  "message": "API category created",
  "data": {
    "id": "61de810e-b48b-4cc1-8f22-959038aadcce",
    "siteId": "my-org-myportal",
    "name": "demo-backend"
  },
  "code": null,
  "request_id": "363146927",
  "error_code": null
}

пользовательский интерфейс

Для редактирования категории:

1. Доступ к странице категорий .
2. Нажмите Редактировать .
3. Измените название категории.
4. Добавить или удалить теги API.
5. Нажмите Сохранить .

завиток

Для редактирования категории :

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories/CATEGORY_ID"  \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "CATEGORY_NAME" }'

Замените следующее:

• ORG_NAME с именем организации. Например, my-org .
• SITE_ID с именем портала, в форме ORG_NAME-PORTAL_NAME , где ORG_NAME является именем организации, а PORTAL_NAME -это имя портала, преобразованное во все строчные и снятые пробелы и тире. Например, my-org-myportal .
• CATEGORY_ID с идентификатором категории. Например, bf6505eb-2a0f-47af-a00a-ded40ac72960 . Разделите несколько идентификаторов категории с запятой. Получите идентификатор категории с командой категорий API списка .
• ACCESS_TOKEN с токеном аутентификации, используемом для доступа к API Apigee Edge. Для получения дополнительной информации об аутентификации и токенах см. Authenticate Access к Edge API .
• CATEGORY_NAME с именем категории. Например, demo-backend .

Ответ полезная нагрузка:

{
  "status": "success",
  "message": "ApiCategory updated",
  "data": {
    "id": "61de810e-b48b-4cc1-8f22-959038aadcce",
    "siteId": "my-org-myportal",
    "name": "demo-backend-test"
  },
  "code": null,
  "request_id": "1976875617",
  "error_code": null
}

пользовательский интерфейс

Чтобы удалить категорию:

1. Доступ к странице категорий .
2. Расположите свой курсор на категорию, которую вы хотите отредактировать, чтобы отобразить меню Actions.
3. Нажмите Удалить .
4. Нажмите Удалить, чтобы подтвердить.

завиток

Чтобы удалить категорию :

curl -X DELETE "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories/CATEGORY_ID" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json"

Замените следующее:

• ORG_NAME с именем организации. Например, my-org .
• SITE_ID с именем портала, в форме ORG_NAME-PORTAL_NAME , где ORG_NAME является именем организации, а PORTAL_NAME -это имя портала, преобразованное во все строчные и снятые пробелы и тире. Например, my-org-myportal .
• CATEGORY_ID с идентификатором категории. Например, bf6505eb-2a0f-47af-a00a-ded40ac72960 . Получите идентификатор категории с командой категорий API списка .
• ACCESS_TOKEN с токеном аутентификации, используемом для доступа к API Apigee Edge. Для получения дополнительной информации об аутентификации и токенах см. Authenticate Access к Edge API .

Ответ полезная нагрузка:

{
  "status": "success",
  "message": "ApiCategory deleted",
  "data": {
  },
  "code": null,
  "request_id": "2032819627",
  "error_code": null
}