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

UI

Чтобы просмотреть каталог 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. Дополнительную информацию об аутентификации и токенах см. в разделе «Аутентификация доступа к API Edge» .

См. примечания по пагинации для получения инструкций по использованию пагинации в ответе.

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

{
  "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 .

UI

Чтобы добавить 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. Дополнительную информацию об аутентификации и токенах см. в разделе «Аутентификация доступа к API Edge» .
• 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 . Несколько идентификаторов категорий разделяются запятой. Получить идентификатор категории можно с помощью команды API list 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 .

UI

Для редактирования 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. Дополнительную информацию об аутентификации и токенах см. в разделе «Аутентификация доступа к API Edge» .

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

   {
     "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
   }
   

UI

Чтобы опубликовать или снять с публикации 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
   }

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

UI

Чтобы управлять видимостью 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» .

UI

Для управления 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» .

UI

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

1. Получите доступ к каталогу API .
2. Если вкладка «API» еще не выбрана, нажмите на нее.
3. Щёлкните по строке API, которую хотите отредактировать.
4. Нажмите Редактировать .

5. В разделе сведений об API :

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

   При указании изображения укажите либо внешний 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» .

UI

Чтобы при редактировании 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
    ],

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

   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» .

UI

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

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» .

UI

Чтобы удалить 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. Дополнительную информацию об аутентификации и токенах см. в разделе «Аутентификация доступа к API Edge» .

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

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

UI

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
}

UI

локон

To download API documentation using 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 with the name of the organization. For example, my-org .
• SITE_ID with the name of the portal, in the form ORG_NAME-PORTAL_NAME , where ORG_NAME is the name of the organization and PORTAL_NAME is the portal name converted to all lowercase and with spaces and dashes removed. For example, my-org-myportal .

• API_DOC with the generated id of the document. For example, 399668 . Use the list API docs command to find this value.

  Response payload:

{
  "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 : The base64-encoded string of contents of the API documentation.

UI

1. Access the API catalog .
2. Click the APIs tab, if not already selected.
3. Click in the row of the API that you want to edit.
4. Click edit Edit .
5. In the API documentation pane, select No documentation .
6. Нажмите « Сохранить ».

локон

To clear existing content use the 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 with the name of the organization. For example, my-org .
• SITE_ID with the name of the portal, in the form ORG_NAME-PORTAL_NAME , where ORG_NAME is the name of the organization and PORTAL_NAME is the portal name converted to all lowercase and with spaces and dashes removed. For example, my-org-myportal .
• API_DOC with the generated id of the document. For example, 399668 . Use the list API docs command to find this value.

Response payload:

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

UI

To view the Categories page:

1. Select Publish > Portals and select your portal.
2. Click API catalog on the portal home page.

   Alternatively, you can select API catalog in the portal drop-down menu in the top navigation bar.

3. Click the Categories tab.

The Categories tab in the API catalog displays the list of the categories that have been defined for your portal.

As highlighted in the previous figure, the APIs page enables you to:

• View the categories and the APIs to which they are tagged
• Add a category
• Edit a category
• Delete a category
• Manage APIs published to your portal. See Explore the API catalog

локон

To list categories :

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

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

• ORG_NAME with the name of the organization. For example, my-org .
• SITE_ID with the name of the portal, in the form ORG_NAME-PORTAL_NAME , where ORG_NAME is the name of the organization and PORTAL_NAME is the portal name converted to all lowercase and with spaces and dashes removed. For example, my-org-myportal .
• ACCESS_TOKEN with the authentication token used to access the Apigee Edge API. For more information on authentication and tokens, see Authenticate access to the Edge API .

Response payload:

{
  "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 : The ID of the category item. For example, 61c1014c-89c9-40e6-be3c-69cca3505620 .

UI

To manually add a category:

1. Access the Categories page .
2. Click + Add .
3. Enter the name of your new category.
4. Optionally, select one or more APIs to tag to the category.
5. Нажмите «Создать» .

локон

To add a category :

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 with the name of the organization. For example, my-org .
• SITE_ID with the name of the portal, in the form ORG_NAME-PORTAL_NAME , where ORG_NAME is the name of the organization and PORTAL_NAME is the portal name converted to all lowercase and with spaces and dashes removed. For example, my-org-myportal .
• ACCESS_TOKEN with the authentication token used to access the Apigee Edge API. For more information on authentication and tokens, see Authenticate access to the Edge API .
• CATEGORY_NAME with the name of the category. For example, demo-backend .

Response payload:

{
  "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
}

UI

To edit a category:

1. Access the Categories page .
2. Нажмите Редактировать .
3. Edit the name of the category.
4. Add or remove API tags.
5. Нажмите « Сохранить ».

локон

To edit a category :

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 with the name of the organization. For example, my-org .
• SITE_ID with the name of the portal, in the form ORG_NAME-PORTAL_NAME , where ORG_NAME is the name of the organization and PORTAL_NAME is the portal name converted to all lowercase and with spaces and dashes removed. For example, my-org-myportal .
• CATEGORY_ID with the ID of the category. For example, bf6505eb-2a0f-47af-a00a-ded40ac72960 . Separate multiple category IDs with a comma. Get the category ID with the list API categories command.
• ACCESS_TOKEN with the authentication token used to access the Apigee Edge API. For more information on authentication and tokens, see Authenticate access to the Edge API .
• CATEGORY_NAME with the name of the category. For example, demo-backend .

Response payload:

{
  "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
}

UI

To delete a category:

1. Access the Categories page .
2. Position your cursor over the category that you want to edit to display the actions menu.
3. Нажмите Удалить .
4. Click Delete to confirm.

локон

To delete a category :

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 with the name of the organization. For example, my-org .
• SITE_ID with the name of the portal, in the form ORG_NAME-PORTAL_NAME , where ORG_NAME is the name of the organization and PORTAL_NAME is the portal name converted to all lowercase and with spaces and dashes removed. For example, my-org-myportal .
• CATEGORY_ID with the ID of the category. For example, bf6505eb-2a0f-47af-a00a-ded40ac72960 . Get the category ID with the list API categories command.
• ACCESS_TOKEN with the authentication token used to access the Apigee Edge API. For more information on authentication and tokens, see Authenticate access to the Edge API .

Response payload:

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