What is Swagger API and OpenAPI Specification?

Swagger API, now more formally known as the OpenAPI Specification (OAS), is a widely used, language-agnostic standard for describing, producing, consuming, and visualising RESTful web services. It provides a machine-readable interface description language for HTTP-based APIs.

Essentially, Swagger/OpenAPI creates a blueprint for an API, detailing all its available endpoints, operations (like GET, POST), parameters, authentication methods, and response formats. This documentation can then be used by developers to understand and interact with the API without needing access to the source code or additional documentation.

In the context of Building Management Systems (BMS), the OpenAPI Specification is becoming increasingly relevant for modern integrations. While traditional BMS often relies on protocols like BACnet and Modbus for field-level communication, APIs are crucial for higher-level integration. BMS can expose its data (e.g., sensor readings, equipment status) and control capabilities through RESTful APIs described by OpenAPI. This allows for seamless integration with enterprise systems (like ERP or CMMS), cloud-based analytics platforms, mobile applications, and other IT infrastructure, enabling a more connected and intelligent building ecosystem.