Page tree
Skip to end of metadata
Go to start of metadata



OpenAPI Specification for the Meteorological Observation API

Background

This page describes how you access the OpenAPI Specification (OAS) for the metObs API. You can read more about OAS in the buttom under "About OpenAPI Specification". The OAS represents a specific version of the Meteorological Observation (metObs) service. By following the link under the endpoint section, you can find both a visual Swagger representation of the OAS as well as a raw YAML file of the OAS.

Endpoint:

You can access the OAS by inserting the service version you want to access in the URL listed in the left column in the table below. In the right column of the table below, you can find an example with a specific version of the service.

OpenAPI endpoint syntaxOpenAPI endpoint example with a specific version of the metObs service
https://dmigw.govcloud.dk/[Insert the service version here]/metObs/api?https://dmigw.govcloud.dk/v2/metObs/api





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.

This has several benefits for the users and for DMI, including:

  • Interactive documentation
  • Code generation for documentation, clients, and servers
  • Automation of test cases
  • Dynamic generation of the documentation directly from the application so the documentation is up-to-date.

OpenAPI documents describe an API's services and are represented in either YAML or JSON formats. The DMI has chosen YAML as the preferred documentation 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







  • No labels