DCAT-AP-UK: DCAT Application Profile for the UK
Help Site map

Tools

Describe an API from OpenAPI

Updated 1 section on this page is new or updated since 1.2.0-rc.1 (2026-11-06). Everything that changed

Paste an OpenAPI description, as JSON, to draft a data service record. The converter copies what OpenAPI holds, lists what it could not find, and checks the result. It never copies an email address. Inspired by the Norwegian oastodcat tool.

Your OpenAPI descriptionUpdated

Used as the endpoint description, and to complete relative server addresses.

For a YAML description, convert it to JSON first.

The example OpenAPI description
{
  "openapi": "3.1.0",
  "info": {
    "title": "Food Hygiene Rating Scheme API",
    "version": "2",
    "description": "Free programmatic access to the Food Standards Agency food hygiene rating data for England, Scotland, Wales and Northern Ireland, with no registration. Written as OpenAPI for the DCAT-AP-UK portal from the FSA endpoint index; the FSA does not publish an OpenAPI file.",
    "license": {
      "name": "Food Standards Agency terms and conditions for the ratings data",
      "url": "https://www.food.gov.uk/ratings-terms-and-conditions"
    },
    "contact": {
      "name": "Food Standards Agency",
      "url": "https://www.food.gov.uk/food-hygiene-rating-scheme-api-version-2"
    }
  },
  "servers": [
    {
      "url": "https://api.ratings.food.gov.uk"
    }
  ],
  "tags": [
    {
      "name": "food hygiene"
    },
    {
      "name": "ratings"
    }
  ],
  "paths": {
    "/BusinessTypes/{pageNumber}/{pageSize}": {
      "get": {
        "summary": "Details of all business types, a page at a time",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/Authorities/basic": {
      "get": {
        "summary": "A basic list of local authorities",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/Regions/basic": {
      "get": {
        "summary": "A basic list of regions",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  }
}

What is copied

OpenAPI to DCAT-AP-UK
OpenAPIDCAT-AP-UKNote
info.titleTitle
info.descriptionDescription
info.versionVersion
servers[].urlEndpoint addressRelative addresses are completed from where it is published.
(where it is published)Endpoint description
openapiConforms toThe OpenAPI specification version.
info.license.urlLicence
info.contact.url and nameContact pointAn email address is never copied.
tags[].nameKeywords
components.securitySchemes(a note)An API with security schemes is probably not open.

Search the portal

Keyboard shortcuts

/ or Ctrl K
Search
?
These shortcuts
Esc
Close menus, tooltips and dialogs
Arrow keys
Move between tabs and search results