Укажите OpenAPI (известная первоначально как спецификация Swagger) является спецификацией интерфейса файла читаемых машин , чтобы описать, производить, потреблять и просматривать веб — служба RESTful . Ряд инструментов может генерировать код, документацию и данные тестового случая из файла интерфейса.
Приложения, реализованные на основе файлов интерфейса OpenAPI, могут автоматически генерировать документацию о методах, параметрах и моделях. Это помогает синхронизировать документацию, клиентские библиотеки и исходный код.
История
Как спецификация, так и реализация структуры начались как инициативы Wordnik. swagger был разработан с использованием Wordnik во время разработки Wordnik Developer и базового API. Развитие Swagger началось в начале 2010 года.
В ноябре 2015 года компания SmartBear, которая поддерживала Swagger, объявила о том, что она помогла создать новую организацию под эгидой Linux Foundation под названием Open API Initiative. Многие компании, включая Google , IBM и Microsoft,являются членами-учредителями. Swagger пожертвовал спецификацию Swagger новой группе. Группа также анализирует RAML и API Blueprint.
1 января 2016 года спецификация Swagger была переименована в OpenAPI Specification и перенесена в новый репозиторий GitHub.
Особенности
Спецификация OpenAPI не требует определенного языка. Он также расширяется по новым технологиям и протоколам через HTTP.
С помощью спецификации объявления ресурса клиенты могут понимать и потреблять сервисы, не зная реализации сервера или доступа к серверному коду.
Интерфейс пользовательского интерфейса Swagger позволяет разработчикам и не-разработчикам взаимодействовать с API в изолированной программной среде пользовательского интерфейса, которая обеспечивает четкое представление о том, как API отвечает на параметры и параметры. Swagger может использовать как JSON, так и XML.
