Skip to content
OpenAPI V3 specifications for api.ideal-postcodes.co.uk
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
spec
web
.gitignore Add gitignore Apr 17, 2019
CHANGELOG.md Fix 500 error response schema on `/postcodes/:postcode` Apr 23, 2019
LICENSE
README.md Fixes for release Apr 17, 2019
package-lock.json
package.json Fixes for release Apr 17, 2019

README.md

OpenAPI

Ideal Postcodes OpenAPI (v3) Specification (api.ideal-postcodes.co.uk)

CircleCI

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

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

Features

  • OpenAPI v3 specification for api.ideal-postcodes.co.uk
  • Automated documentation generator
  • OpenAPI specification testing and linting
  • Automated deploys to openapi.ideal-postcodes.dev

Links

Getting Started

Build specifications

npm run build

Run spec validation

npm test

Download and Access via npm

Install

npm install @ideal-postcodes/openapi

Require specs

const { spec } = require("@ideal-postcodes/openapi");

Licence

MIT

You can’t perform that action at this time.