Nuxt 2 is reaching End-of-Life on June 30th, 2024.

nuxt-openapi-docs-module
nuxt-openapi-docs-module

Generate pages from OpenAPI specifications

OpenApiDocs Nuxt Module Documentation

logo

Introduction

The OpenApiDocs Nuxt Module is designed to seamlessly integrate OpenAPI documentation into Nuxt.js applications, supporting both Nuxt 2.x and 3.x. It utilizes Vue.js components to render the OpenAPI specifications dynamically. This module is ideal for developers looking to embed API documentation directly into their Nuxt.js projects.

work with static and server target

Package Version Information

VersionSupported Nuxt Version
4.x2.x and 3.x
5.0,5.13.x
>=5.2>=3.7

Documentation and Support

Features

  • Support for Nuxt 2.x and 3.x: Works with both major versions of Nuxt.
  • Dynamic Documentation Rendering: Automatically renders OpenAPI specifications using Vue.js components.
  • Customizable: Offers several options to customize the documentation setup.
  • Localization Support: Integrates with the i18n plugin for multi-language support.
  • Development Tools: Includes tools and setups for development and customization of the module.

white imagewhite image 2black imagemobile image

Installation

Quick Setup

  1. Add the module to your project:
  npx nuxi@latest module add nuxt-openapi-docs-module
  1. Configure the module in your Nuxt configuration:

For Nuxt 3:

export default defineNuxtConfig({
 modules: [
   'nuxt-openapi-docs-module'
 ]
})

For Nuxt 2:

module.exports = {
 modules: [
   'nuxt-openapi-docs-module',
 ],
}
  1. Create the OpenAPI documentation folder:
  • Default folder: 'docs/openapi'
  • Alternatively, specify a custom folder using the 'folder' option in the module configuration.

Configuration

Customize the module by modifying the 'nuxt.config.js' or 'nuxt.config.ts' file:

module.exports = {
  modules: [
    [
      'nuxt-openapi-docs-module',
      {
        folder: './docs/openapi',
        name: 'OpenApiDocs',
        files: function() { return { 'News-API': 'News API' } },
      }
    ],
  ],
  // Additional configurations...
}

Options

  • 'folder': Path to the folder containing OpenAPI specification files.
  • 'name': Name of the main component.
  • 'files': Function returning an object mapping file names to display names.
  • 'debug': Enable debug mode to print information to the console.
  • 'list': Toggle the display of document listings.
  • 'locales': Define supported locales.
  • 'logo': Custom logo in SVG format.
  • 'footer': Custom footer content.