pakt-api

Pakt-API

Presentation

Pakt-API is an API documentation generator.

• Fully comptabible with Typescript
• One static HTML output page
• Written in Typescript and styled with Bulma

Installation

npm install --save pakt-api or yarn add pakt-api

Usage

NodeJS

import Pakt, {PaktAPI} from 'pakt-api'

const paktApi : PaktAPI = {...}

const pakt = new Pakt('/path/folder/', 'documentation.html')
pakt.generate(paktApi)

With ExpressJS

import express from 'express'
import Pakt, {PaktAPI} from 'pakt-api'

const paktApi : PaktAPI = {...}
const pakt = new Pakt('/path/folder/', 'documentation.html')
pakt.generate(paktApi)

const app = express()
app.use('/documentation', express.static('/path/documentation.html'))

app.listen(3000, ()=> {console.log('My Pakt server is running')})

Pakt API Options

In progress

More coming

• Adding route définition on runtime
• Rebuild documentation on demand
• Generated Joi validation object
• Support of other mimetypes
• Bulma customization