Table of Contents

• About
• Installation
• Usage
• Development / Contributing

About

This is a plugin for stapigen that generates OpenAPI 3 definitions.

Install

yarn add stapigen
yarn add stapigen-plugin-openapi

Usage

Add it to the list of plugins in your stapigen.conf.js:

const { default: pluginOpenAPI } = require('stapigen-plugin-openapi');

module.exports = {
	// ... other configuration options ...
	plugins: [
		pluginOpenAPI({
			dir: './',
			fileName: 'spec.json',
			spec: {
				info: {
					title: 'Test',
					version: '1.0.0',
				},
				openapi: '3.0.0',
			},
		}),
	],
};

Development / Contributing

Run tests

yarn run test

Commit messages

This project uses semantic-release for automated release versions. So commits in this project follow the Conventional Commits guidelines. I recommend using commitizen for automated commit messages.