UNPKG

@ideal-postcodes/openapi

Version:

Ideal Postcodes OpenAPI v3 specifications

github.com/ideal-postcodes/openapi

ideal-postcodes/openapi

51 lines (32 loc) • 1.16 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
<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.co.uk) - 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) ## 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 Copyright IDDQD Limited