exframe-api module

exframe-api will process the API specification with a CLI tool. exframe-api will be the layer on top of express to declare and produce the openapi.json specification files.

Features

It will produces openapi.json file from the provided schema in file routes/api.js relative to root directory.

Use

const { Api } = require('exframe-api');

Full Example

const { Api } = require('exframe-api');

const api = new Api('property-search', {
  summary: 'property search service',
  description: 'we can search properties with help of this service',
  version: '1.0',
  termsOfService: 'http://some-url',
  contactName: 'joe',
  contactUrl: 'joeswebsite.com',
  contactEmail: '[email protected]',
  licenseName: 'best license',
  licenseIdentifier: 'best license',
  licenseUrl: 'license.com'
});

api.servers = [{ url: 'http://property-search' }];

require('./resource')(api);

module.exports = api;

Tests

npm run test

How to generate to openapi.json

exframe-api's cli can generate openapi.json file. You can add a script in package.json, as shown below

  "gen-spec": "node ./node_modules/exframe-api/cli.js > openapi.json"

running this command will generate openapi.json, based on the schema provided in routes/api.js. The generated file will be according to the specification provided here - https://spec.openapis.org/oas/v3.1.0