@ideal-postcodes/openapi/README.md

Ideal Postcodes OpenAPI v3 specifications

<h1 align="center">
  <img src="https://img.ideal-postcodes.co.uk/OpenAPI%20Logo@3x.png" alt="OpenAPI">
</h1>

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

[![CI](https://github.com/ideal-postcodes/openapi/actions/workflows/ci.yml/badge.svg)](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