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.
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 | DCAT-AP-UK | Note |
|---|---|---|
| info.title | Title | |
| info.description | Description | |
| info.version | Version | |
| servers[].url | Endpoint address | Relative addresses are completed from where it is published. |
| (where it is published) | Endpoint description | |
| openapi | Conforms to | The OpenAPI specification version. |
| info.license.url | Licence | |
| info.contact.url and name | Contact point | An email address is never copied. |
| tags[].name | Keywords | |
| components.securitySchemes | (a note) | An API with security schemes is probably not open. |