Как опубликовать 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, связанные продукты которых были удалены из Apigee Edge, и воссоздавать эти продукты или удалять API с портала.

curl

Чтобы посмотреть список 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 с токеном аутентификации, используемым для доступа к Apigee 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 Schema (Схема GraphQL). Нажмите Выбрать документ. Найдите и выберите схему GraphQL. Нажмите Выбрать. Вы также можете выбрать No documentation (Нет документации) и добавить ее позже, после того как API будет добавлен, как описано в разделе Управление снимком документа.
   Видимость API	Если вы не зарегистрировались для бета-тестирования функции управления аудиториями, выберите один из следующих вариантов: Анонимные пользователи, чтобы разрешить всем пользователям просматривать API. Прошедшие регистрацию, чтобы разрешить доступ к API только зарегистрированным пользователям. Если вы зарегистрировались для участия в бета-тестировании функции управления аудиториями, выберите один из следующих вариантов: Общедоступный, чтобы все пользователи могли просматривать API. Аутентифицированные пользователи, чтобы разрешить доступ к API только зарегистрированным пользователям. Выбранные аудитории, чтобы выбрать определенные аудитории, которым вы хотите предоставить доступ к API. Вы можете настроить видимость аудитории позже, как описано в статье Как управлять видимостью API на портале.
   Изображение для показа	Чтобы добавить изображение на карточку API на странице API, нажмите Выбрать изображение. В диалоговом окне Выбрать изображение выберите существующее изображение, загрузите новое или укажите URL внешнего изображения и нажмите Выбрать. Посмотрите значок API и нажмите Выбрать. Вы можете добавить изображение позже, как описано в разделе Как управлять изображением для карточки API. Если вы укажете изображение с внешним URL, оно не будет загружено в ваши объекты. Кроме того, загрузка изображения в интегрированном портале будет зависеть от его доступности, которая может быть заблокирована или ограничена правилами безопасности контента.
   Категории	Добавьте категории, к которым будет относиться API, чтобы разработчики приложений могли находить связанные API на странице API. Чтобы определить категорию: Выберите категорию из раскрывающегося списка. Чтобы добавить новую категорию, введите ее название и нажмите Ввод. Новая категория будет добавлена на страницу "Категории" и станет доступна при добавлении или изменении других API.

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

curl

Чтобы добавить 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 с токеном аутентификации, используемым для доступа к Apigee 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 categories.
• 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. Нажмите Сохранить.

curl

После того как вы добавите API, используйте вызов update, чтобы вносить изменения.

В этом примере показано, как изменить статус опубликованного 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 с токеном аутентификации, используемым для доступа к Apigee 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. Включите изменяемые значения, которые вы хотите сохранить, в вызов update и измените значения, которые нужно поменять. Если вы не укажете строку, будут использоваться настройки по умолчанию. В этом примере измените значение параметра published с 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. Нажмите Сохранить.

curl

В вызове обновления укажите один из следующих параметров:

"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, используйте вызов update. Укажите изменяемые значения, которые вы хотите сохранить, и измените те, которые нужно поменять. Если вы не укажете изменяемый параметр, он будет перезаписан значением по умолчанию.

   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. Нажмите Отправить.

curl

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

Если вы не включили функцию управления аудиториями, видимость регулируется с помощью 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, используйте вызов update. Укажите изменяемые значения, которые нужно сохранить, и измените те, которые нужно поменять. Если вы не укажете изменяемый параметр, будет использовано значение по умолчанию.

   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. Нажмите Сохранить.

curl

Включите в вызов 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, используйте вызов update. Укажите изменяемые значения, которые нужно сохранить, и измените те, которые нужно поменять. Если вы не укажете изменяемый параметр, будет использовано значение по умолчанию.

   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 details (Сведения об API):

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

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

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

curl

В вызове 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, используйте вызов update. Укажите изменяемые значения, которые нужно сохранить, и измените те, которые нужно поменять. Если вы не укажете изменяемый параметр, будет использовано значение по умолчанию.

   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.
6. Повторите эти действия, чтобы добавить теги API в другие категории.
7. Нажмите Сохранить.

curl

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

  # Omit line for no categories

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

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

Чтобы изменить 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, используйте вызов update. Укажите изменяемые значения, которые нужно сохранить, и измените те, которые нужно поменять. Если вы не укажете изменяемый параметр, будет использовано значение по умолчанию.

   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. Нажмите Сохранить.

curl

В вызове 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, используйте вызов update. Укажите изменяемые значения, которые нужно сохранить, и измените те, которые нужно поменять. Если вы не укажете изменяемый параметр, будет использовано значение по умолчанию.

   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. Нажмите на значок с тремя точками Удалить.

curl

Чтобы удалить 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 с токеном аутентификации, используемым для доступа к Apigee 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 documentation (Документация по API) нажмите Select Document (Выбрать документ) и выберите новый документ.
7. На панели Документация по API выберите один из следующих вариантов:
   • Документ OpenAPI
   • Схема GraphQL
8. Нажмите Выбрать документ и выберите последнюю версию документа.
9. Для GraphQL укажите URL конечной точки.
10. Нажмите Сохранить.

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

curl

Чтобы обновить содержимое документации 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
}

Интерфейс

curl

Чтобы скачать документацию по API с помощью команды get documentation:

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. Чтобы найти это значение, используйте команду list API docs.

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

{
  "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 – строка в кодировке Base64, содержащая документацию по API.

Интерфейс

1. Каталог API.
2. Нажмите на вкладку API, если она ещё не выбрана.
3. Нажмите на строку API, который хотите изменить.
4. Нажмите edit Изменить.
5. На панели API documentation (Документация по API) выберите No documentation (Нет документации).
6. Нажмите Сохранить.

curl

Чтобы удалить существующий контент, используйте update 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. Чтобы найти это значение, используйте команду list API docs.

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

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

Интерфейс

Чтобы открыть страницу "Категории":

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

   Также можно выбрать Каталог API в раскрывающемся меню портала на панели навигации вверху.

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

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

Как показано на рисунке выше, на странице API можно:

• Как посмотреть категории и API, к которым они относятся
• Как добавить категорию
• Как изменить категорию
• Как удалить категорию
• Управление API, опубликованными на портале. Подробнее о каталоге API…

curl

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

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 с токеном аутентификации, используемым для доступа к Apigee 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

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

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 с токеном аутентификации, используемым для доступа к Apigee 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

Чтобы изменить категорию:

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. Если идентификаторов несколько, перечислите их через запятую. Получите идентификатор категории с помощью команды list API categories.
• ACCESS_TOKEN с токеном аутентификации, используемым для доступа к Apigee 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. Наведите курсор на категорию, которую хотите изменить, чтобы открыть меню действий.
3. Нажмите на значок с тремя точками Удалить.
4. Нажмите Удалить, чтобы подтвердить действие.

curl

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

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. Получите идентификатор категории с помощью команды list API categories.
• ACCESS_TOKEN с токеном аутентификации, используемым для доступа к Apigee Edge API. Подробнее об аутентификации и токенах…

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

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