docs/translations/ru-RU/content/rest/overview/openapi-description.md

title, intro, versions, topics, ms.openlocfilehash, ms.sourcegitcommit, ms.translationtype, ms.contentlocale, ms.lasthandoff, ms.locfileid

title	intro	versions	topics	ms.openlocfilehash	ms.sourcegitcommit	ms.translationtype	ms.contentlocale	ms.lasthandoff	ms.locfileid
Описание OpenAPI	REST API {% data variables.product.product_name %} полностью описан в документе по OpenAPI 3.0.	fpt ghes ghec * * *	API	84c81c856da1da67320463fba4b9b52bca88c844	fcf3546b7c	HT	ru-RU	09/10/2022	145125043

Сведения об описаниях OpenAPI

OpenAPI является стандартной спецификацией для описания REST API. Описания OpenAPI позволяют как людям, так и компьютерам обнаруживать возможности API без необходимости предварительного чтения документации или изучения реализации. {% data variables.product.company_short %} сделал свои REST API общедоступными в виде документа, совместимого с OpenAPI 3.0.

Получение описания OpenAPI {% data variables.product.company_short %}

Это описание можно найти в репозитории Описание OpenAPI REST API с открытым кодом.

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

Использование описания OpenAPI {% data variables.product.company_short %}

Существует множество способов использования описания OpenAPI. Например, можно сделать следующее:

• Создать собственный клиент API.
• Проверять и тестировать интеграцию REST API {% data variables.product.company_short %}.
• Исследовать и взаимодействовать с REST API {% data variables.product.product_name %} с помощью сторонних средств, таких как Insomnia или Postman.

Например, {% data variables.product.company_short %} использует описание OpenAPI REST для создания справочной документации по REST API {% data variables.product.product_name %}.