Есть ли OpenAPI или другая спецификация API для Amazon Connect API?

Я хочу познакомиться с API Amazon Connect. Я видел ссылку ниже, но мне трудно ее использовать, потому что навигация представляет собой плоский алфавитный список конечных точек, упорядоченных по действию, а не по ресурсам. Следует отметить, что конечные точки отсортированы по алфавиту, начиная с Delete, Get, List, Update и других, хотя было бы неплохо сгруппировать их по ресурсам.

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

Я использую следующую справку по API:

https://docs.aws.amazon.com/connect/latest/APIReference

Также подойдет любой другой формат спецификации, такой как RAML или проприетарный формат. Например, Google предоставляет собственный формат Google Discovery, который можно преобразовать в OpenAPI. Следующее упоминается на https://googleapis.github.io/.

OpenAPI

Мы рекомендуем использовать инструменты на основе OpenAPI и OpenAPI для работы с REST API Google. Было опубликовано несколько инструментов для преобразования формата Google Discovery Format в OpenAPI:

  • google-discovery-to-swagger, скрипт с открытым исходным кодом под лицензией MIT для преобразования формата Google Discovery в Swagger 2.0.
  • API Spec Converter, онлайн-конвертер от LucyBot.
  • Преобразователь API от APIMatic.

Инструменты OpenAPI Google включают gnostic, интерфейс для инструментов OpenAPI, который считывает описания OpenAPI, помещает их в эффективное двоичное представление и позволяет легко писать эффективные плагины и автономные инструменты на любом языке программирования с поддержкой Protocol Buffer.

Есть ли для этого API OpenAPI или другая спецификация? Если есть, я хотел бы обновить его тегами, а затем отобразить в более удобном для использования формате.

Обновление: Aossey отмечает, что Amazon не публикует спецификации OpenAPI для своих API. Чтобы решить эту проблему, я начал собирать некоторую информацию в репозитории ниже, что может привести к спецификации OpenAPI. Не стесняйтесь вносить свой вклад.

https://github.com/grokify/amazon-api-specs/blob/master/connect/endpoints.csv.


openapi amazon-connect contact-center
person Grokify    schedule 25.01.2021    source источник

Ответы (1)


arrow_upward
1
arrow_downward

Короткий ответ: нет, спецификации OpenAPI для этих API нет.

Эти функции (перечисленные в связанных документах) реализованы в AWS SDK и AWS CLI. Хотя существуют базовые конечные точки HTTP, их нелегко использовать так, как вы, скорее всего, ищете. SDK и CLI позаботятся об аутентификации / авторизации (через службу IAM) и запросят подпись за вас, который вам пришлось бы реализовать самостоятельно, если бы вы собирались напрямую использовать конечные точки.

person Aossey    schedule 26.01.2021
comment
Это прискорбно. Так ли обстоит дело со всеми API Amazon? Спецификация OpenAPI используется как для создания документации, так и для клиентских SDK, а также для непосредственного использования. Я много использую Go. В Go легко позаботиться о Auhn / authz и подписи запроса в общем *http.Client, который отделен от кода пути и модели. - person Grokify; 26.01.2021
comment
Все API-интерфейсы AWS реализованы / представлены таким же образом, как я описал выше. Клиенты могут использовать OpenAPI / swagger для реализации пользовательских API в сервисе шлюза API, но API, используемые для управления сервисами AWS сами по себе, не публикуют спецификации OpenAPI. - person Aossey; 26.01.2021
comment
Хорошо знать. Спасибо. Я начал собирать некоторую информацию о спецификациях API, чтобы упростить мне использование API. - person Grokify; 26.01.2021