OAS означает спецификацию OpenAPI, которая представляет собой спецификацию для создания, документирования и использования RESTful API. Базовая структура OAS состоит из нескольких ключевых компонентов:
-
Версия OpenAPI: указывает версию используемой спецификации OpenAPI, например «3.0.0».
-
Объект Paths: определяет доступные конечные точки API и соответствующие методы HTTP (GET, POST, PUT, DELETE и т. д.), которые можно использовать для взаимодействия с этими конечными точками.
-
Параметры: позволяет определять параметры, которые можно использовать в конечных точках API, например параметры запроса или параметры пути.
-
Ответы. Описываются возможные ответы, которые могут быть возвращены API, включая коды состояния HTTP, тела ответов и заголовки.
-
Схемы: определяют модели и структуры данных, используемые в API, включая полезные данные запросов и ответов.
-
Безопасность: определяет требования безопасности и механизмы аутентификации и авторизации запросов API.
-
Теги. Позволяет классифицировать и группировать конечные точки API с помощью тегов. Это помогает эффективно организовать и документировать API.
Следуя спецификации OpenAPI, вы можете создать стандартизированное и машиночитаемое описание вашего API, которое можно использовать для автоматического создания документации, тестирования API и генерации клиентского кода.