@digitalroute/bagger

🎒 Bagger

A joi-compatible tool for building swagger definitions. It enables developers use the same joi schemas for validation and documentation, ensuring that API documentation never becomes stale.

Features

• 🔨 Builder pattern: Dead simple api to create complex Swagger definitions.
• ✨ joi compatibility: Enables developers to use the same schemas for validation and documentation.
• 🔎 Intellisense: Really nice intellisense suggestions, and TypeScript definitions.

Table of Contents

WIP

Example

const bagger = require('bagger');
const joi = require('@hapi/joi');

const getBags = bagger
  .request()
  .method('get')
  .path('/bags')
  .tag('bags')
  .tag('build')
  .responses([
    bagger
      .response(200)
      .description('Successfully fetched all bags')
      .content(
        'application/json',
        joi
          .array()
          .items(joi.string())
          .example(['handbag', 'backpack'])
      )
  ]);

const swaggerConfig = {
  title: 'Bagger API',
  version: 'v1',
  description: 'Provides resources for building swagger definitions'
};

const swaggerDefinition = bagger.compile(swaggerConfig, [getBags]);

Installation

Install bagger using npm:

npm install bagger