@knuckleswtf/scribe

Generate API documentation for humans from your Node.js codebase.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@knuckleswtf/scribe
5312.0.2a year ago3 years agoMinified + gzip package size for @knuckleswtf/scribe in KB

Readme

Scribe for Node.js


Automatically generate API documentation for humans from your Node.js codebase. Here's what the output looks like. There's a Laravel version, too! npm version npm Build Status
👋 Scribe helps you generate docs automatically, but if you really want to make friendly, maintainable and testable API docs, there's a few more things you need to know. So I made a course for you.

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

Node.js 12.4.0 or higher is required. Supported frameworks:
  • Adonis.js 4
  • Express 4
  • Restify 8
```bash
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.knuckles.wtf/nodejs.