@soluzioni-futura/docs-helper
TypeScript icon, indicating that this package has built-in type declarations

1.0.11 • Public • Published

Setup

Run the following command:

$ npm i @soluzioni-futura/docs-helper

Usage

import { OpenAPIV3 }, DocsHelperRouter from "@soluzioni-futura/docs-helper"
import definition from "./definition.json"
import express from "express"

const app = express()

/* ... */

app.use(DocsHelperRouter({
    definition: definition as OpenAPIV3.Document,
    endpoint: "/docs"
}))

app.listen(8000, () => {
    console.log("App is listening on port 8000!")
})

Check http://localhost:8000/docs

The definition can be provided by local path

Readme

Keywords

none

Package Sidebar

Install

npm i @soluzioni-futura/docs-helper

Weekly Downloads

3

Version

1.0.11

License

ISC

Unpacked Size

5.22 kB

Total Files

7

Last publish

Collaborators

  • giovanni.bruno
  • nico.fuccella
  • vforvalerio87
  • zhoujian26
  • riccardorispoli
  • allemonta