Skip to content
This repository has been archived by the owner. It is now read-only.

knuckleswtf/scribe-js

master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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
# 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.

About

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

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published