Open API Specification

OpenAPI Specification is an API description format for REST APIs. Our OpenAPI files describe the entire API including available endpoints, operation parameters and request outputs.

Features

• OpenAPI v3 specification for api.ideal-postcodes.co.uk
• Exports API Typings

Links

• Github Repository
• OpenAPI v3 Raw Files: JSON
• OpenAPI v3 Raw Files: YAML
• NPM Package

A number of Open Source Tools are available for you to consume our API specifications.

Install

npm install @ideal-postcodes/openapi

Use Specifications

JSON and YAML specs can be accessed at node_modules/@ideal-postcodes/openapi/dist/openapi.json or node_modules/@ideal-postcodes/openapi/dist/openapi.json