@knuckleswtf/scribe-express v2.0.2

Automatically generate API documentation for humans from your Node.js codebase. Here's what the output is going to look like.

Looking to document your Laravel/Lumen/Dingo APIs easily? Check out Scribe for Laravel.

Features

• Pretty HTML documentation page, with included code samples and friendly text
• Included "Try It Out" button so users can test endpoints right from their browser
• Markdown source files that can be edited to modify docs
• Safely calls API endpoints to generate sample responses, with authentication and other custom configuration supported
• Supports Postman collection and OpenAPI (Swagger) spec generation

Installation

Note: Scribe for JS is still in beta, but we're on our way to stabilizing things. Things may break or change between releases (0.x). Thanks for trying it, and feel free to send in any feedback!

Node.js 12.4.0 or higher is required.

Supported frameworks:

• Adonis.js
• Express
• Restify

Fastify support coming soon!

# For Adonis.js
npm i @knuckleswtf/scribe-adonis

# For Express
npm i @knuckleswtf/scribe-express

# For Restify
npm i @knuckleswtf/scribe-restify

Documentation

View the docs at scribe-js.rtfd.io;

About Scribe for Node.js

Scribe is a port of Scribe for Laravel.