> Ideal Postcodes OpenAPI (v3) Specification (api.ideal-postcodes.co.uk) [](https://github.com/ideal-postcodes/openapi/actions/workflows/ci.yml) ## Features - OpenAPI v3 specification for api.ideal-postcodes.co.uk - Exports API Typings ## Links - [Github Repository](https://github.com/ideal-postcodes/openapi) - [API Reference](https://openapi.ideal-postcodes.dev) - OpenAPI v3 Raw Files: [JSON](https://openapi.ideal-postcodes.dev/openapi.json) - OpenAPI v3 Raw Files: [YAML](https://openapi.ideal-postcodes.dev/openapi.yaml) - [NPM Package](https://www.npmjs.com/package/@ideal-postcodes/openapi) ## Getting Started ### Build Typings ``` npm run build ``` ### Validate Spec ``` npm test ``` ### Download and Access via npm #### Install ```bash npm install @ideal-postcodes/openapi ``` #### Require specs JSON and YAML specs can be accessed at `node_modules/@ideal-postcodes/openapi/dist/openapi.[json|yaml]` ## Licence MIT