OpenAPI (спецификация)

The OpenAPI Specification (с англ. — «спецификация OpenAPI»; изначально известная как Swagger Specification[1]) — формализованная спецификация и экосистема множества инструментов, предоставляющая интерфейс между front-end системами, кодом библиотек низкого уровня и коммерческими решениями в виде API. Вместе с тем, cпецификация построена таким образом, что не зависит от языков программирования, и удобна в использовании как человеком, так и машиной[2].

Относительно назначения, OpenAPI рассматривается как универсальный интерфейс для пользователей (клиентов) по взаимодействию с сервисами (серверами). Если спроектирована спецификация для некоторого сервиса, то на её основании можно генерировать исходный код для библиотек клиентских приложений, текстовую документацию для пользователей, варианты тестирования и др. Для этих действий имеется большой набор инструментов для различных языков программирования и платформ[3][2].

Изначально разработка спецификации под названием Swagger Specification проводилась с 2010 года компанией SmartBear. В ноябре 2015 года SmartBear объявила, что она работает над созданием новой организации Open API Initiative при спонсорской поддержке Linux Foundation. 1 января 2016 года спецификация была переименована в The OpenAPI Specification, а её развитие ведётся в рамках Open API Initiative.

Описание

OpenAPI представляет собой формализованную спецификацию и полноценный фреймворк для описания, создания, использования и визуализации веб-сервисов REST. Задачей является позволить клиентским системам и документации синхронизировать свои обновления с изменениями на сервере. Это достигается тем, что методы, параметры, модели и другие элементы посредством OpenAPI интегрируются с программным обеспечением сервера и всё время с ним синхронизируются[4].

История

Swagger

Появление спецификации и начало работ над фреймворком обусловлены инициативой компании Wordnik, для внутренних нужд которой компанией SmartBear был разработан Swagger. Проект стартовал в начале 2010 года[4]. В марте 2015 года SmartBear выкупила спецификацию OpenAPI у Reverb technologies и перевела его развитие в open source[5].


OpenAPI Specification

В ноябре 2015 SmartBear, как компания, поддерживающая работы над Swagger, анонсировала, что она помогает в создании новой организации Open API Initiative под спонсорством Linux Foundation. Членами данной организации стало множество компаний, включая Google, IBM, Microsoft и др.[6][7] SmartBear подарила этой новой группе спецификацию Swagger[8].

Другими технологиями, предоставляющими подобные решения, как и OpenAPI, являются RAML и API Blueprint[9].

В 2016 году Swagger получил награду API Award в категории API Infrastructure[10].

Особенности

Спецификация не зависит от языка программирования, и может быть использована вне протокола HTTP. OpenAPI одновременно применяется для клиента, сервера и соответствующей документации интерфейса, созданного согласно REST[4].

Спецификация декларативна, и поэтому может быть использована клиентами без знаний особенностей серверной реализации. При этом работать с OpenAPI могут как разработчики, так и рядовые пользователи через готовые инструменты и предоставляемые интерфейсы. В качестве формата используется XML и JSON, но в общем случае может быть выбран и другой язык разметки[4] (например, YAML[значимость факта?]).

См. также

Примечания
  1. OpenAPI Specification (aka Swagger RESTful API Documentation Specification)
  2. Swagger, Getting Started
  3. Swagger, Tools and Integrations
  4. OAI/OpenAPI-Specification
  5. SmartBear Assumes Sponsorship of Swagger API Open Source Project
  6. SmartBear, Linux Foundation launch Open API Initiative to Evolve Swagger
  7. New Collaborative Project to Extend Swagger Specification for Building Connected Applications and Services Архивировано 3 ноября 2016 года.
  8. Amazon API Gateway Now Supports Swagger Definition Import
  9. In 2016, the need for an API meta-language will crystallize
  10. http://apiawards.co/#categories

Ссылки
This article is issued from Wikipedia. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.