Get unlimited public & private packages + team-based management with npm Teams.Learn more »

@ideal-postcodes/openapi

0.0.1 • Public • Published

OpenAPI

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

CircleCI

OpenAPI Specification is an API description format for REST APIs. Our OpenAPI files describes the entire API including available endpoints, operation parameters and request outputs.

A number of Open Source Tools are available for you to consume our API specifications.

Features

  • OpenAPI v3 specification for api.ideal-postcodes.co.uk
  • Automated documentation generator
  • OpenAPI specification testing and linting
  • Automated deploys to openapi.ideal-postcodes.dev

Links

Getting Started

Build specifications

npm run build

Run spec validation

npm test

Download and Access via npm

Install

npm install @ideal-postcodes/openapi

Require specs

const { spec } = require("@ideal-postcodes/openapi");

Licence

MIT

Install

npm i @ideal-postcodes/openapi

DownloadsWeekly Downloads

4

Version

0.0.1

License

MIT

Unpacked Size

93.9 kB

Total Files

6

Last publish

Collaborators

  • avatar