Class OpenAPI

Example

import routing from '@novice1/routing';
import { OpenAPI } from '@novice1/api-doc-generator';

const router = routing().post(...);
const openapi = new OpenAPI();
const routes = openapi.add(router.getMeta());
const { path, method, schema } = routes[0];
Copy

Example:

import {
  BasicAuthUtil
} from '@novice1/api-doc-generator';

const basicAuth = new BasicAuthUtil('basicAuth');

openapi.addDefaultSecurity(basicAuth);
Copy

Example:

openapi.addDefaultSecurity({
 basicAuth: []
});
Copy

Example:

openapi.addDefaultSecurity({
 basicAuth: []
});
Copy

Example:

openapi.addDefaultSecurity('basicAuth');
Copy

Example:

openapi.addResponse('200', {
   "description": "A simple string response",
   "content": {
     "text/plain": {
       "schema": {
         "type": "string",
         "example": "whoa!"
       }
     }
   }
});
Copy

Example:

import {
  ResponseUtil,
  GroupResponseUtil
} from '@novice1/api-doc-generator';

const generalError = new ResponseUtil('GeneralError');
generalError
  .setDescription('General Error')
  .addMediaType('application/json', {
    schema: {
      $ref: '#/components/schemas/GeneralError'
    }
  });

const illegalInput = new ResponseUtil('IllegalInput');
illegalInput
  .setDescription('Illegal input for operation.');

const responses = new GroupResponseUtil([
  generalError,
  illegalInput
]);

openapi.addResponse(responses);
// or
openapi
  .addResponse(generalError)
  .addResponse(illegalInput);
Copy

Example:

openapi
  .addSecuritySchemes('basicAuth', {
    type: 'http',
    scheme: 'basic'
  });
Copy

Example:

import {
  BasicAuthUtil
} from '@novice1/api-doc-generator';

const basicAuth = new BasicAuthUtil('basicAuth');

openapi.addSecuritySchemes(basicAuth);
Copy

remove unused entities (possibly auto-generated) from components:

• headers
• responses
• requestBodies
• parameters
• schemas

remove all routes

Example:

import {
  BasicAuthUtil
} from '@novice1/api-doc-generator';

const basicAuth = new BasicAuthUtil('basicAuthName');

openapi.setDefaultSecurity(basicAuth);
Copy

Example:

openapi.setDefaultSecurity({
 basicAuth: []
});
Copy

Example:

openapi.setDefaultSecurity('basicAuth');
Copy

OpenAPI.setServers({ url })

Example:

import {
  ResponseUtil,
  GroupResponseUtil
} from '@novice1/api-doc-generator';

const generalError = new ResponseUtil('GeneralError');
generalError
  .setDescription('General Error')
  .addMediaType('application/json', {
    schema: {
      $ref: '#/components/schemas/GeneralError'
    }
  });

const responses = new GroupResponseUtil([
  generalError,
  // ... other responses
]);

openapi.setResponses(generalError);
// or 
openapi.setResponses(responses);
Copy

Example:

openapi
  .setSecuritySchemes({
    basicAuth: {
      type: 'http',
      scheme: 'basic'
    }
  });
Copy

Example:

import {
  BasicAuthUtil
} from '@novice1/api-doc-generator';

const basicAuth = new BasicAuthUtil('basicAuth');

openapi.setSecuritySchemes(basicAuth);
Copy