# Open API Specification

![OpenAPI](https://img.ideal-postcodes.co.uk/OpenAPI%20Logo@3x.png)

[![CI](https://github.com/ideal-postcodes/openapi/actions/workflows/ci.yml/badge.svg)](https://github.com/ideal-postcodes/openapi/actions/workflows/ci.yml)

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[​](#features "Direct link to Features")

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

## Links[​](#links "Direct link to Links")

* [Github Repository](https://github.com/ideal-postcodes/openapi)
* OpenAPI v3 Raw Files: [JSON](https://openapi.ideal-postcodes.co.uk/openapi.json)
* OpenAPI v3 Raw Files: [YAML](https://openapi.ideal-postcodes.co.uk/openapi.yaml)
* [NPM Package](https://www.npmjs.com/package/@ideal-postcodes/openapi)

A number of [Open Source Tools](https://swagger.io/tools/open-source/open-source-integrations/) are available for you to consume our API specifications.

## Install[​](#install "Direct link to Install")

```
npm install @ideal-postcodes/openapi
```

### Use Specifications[​](#use-specifications "Direct link to 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.yaml`