https://github.com/ideal-postcodes/openapi

OpenAPI V3 specifications for api.ideal-postcodes.co.uk
https://github.com/ideal-postcodes/openapi

openapi openapi-specification openapi3 swagger

Last synced: 9 days ago
JSON representation

OpenAPI V3 specifications for api.ideal-postcodes.co.uk

• Host: GitHub
• URL: https://github.com/ideal-postcodes/openapi
• Owner: ideal-postcodes
• License: mit
• Created: 2019-04-17T13:41:02.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-28T18:19:47.000Z (18 days ago)
• Last Synced: 2024-11-04T06:03:26.591Z (12 days ago)
• Topics: openapi, openapi-specification, openapi3, swagger
• Language: TypeScript
• Homepage: https://openapi.ideal-postcodes.dev
• Size: 2.72 MB
• Stars: 3
• Watchers: 5
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



> 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