About OpenAPI Specification
DMI's Open Data API documentation is in accordance with the OpenAPI Specification (OAS) standard, which is recommended by the Danish Agency for Digitisation (Danish: Digitaliseringsstyrelsen) in their guidelines for web services. OAS defines a standard programming language-agnostic interface description for REST APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic.
OpenAPI documents describe an API's services and are represented in either YAML or JSON formats. DMI only supports JSON as the OpenAPI resource format.
The OpenAPI Specification provides information about multiple aspects of the service such as:
- Basic information about the web service (e.g. name, version, url, etc.)
- Resources and verbs
- Operations
- Parameters
- Responses
- Schemas
- Security