Installations

npm install @surveylegend/hapi-docs

Developer Guide

BETA

Typescript

No

Module System

ESM

Min. Node Version

>=14

Node Version

18.11.0

NPM Version

9.6.6 Score

56.3

Supply Chain

98.4

Quality

79.8

Maintenance

50

Vulnerability

98.9

License

Pull Requests

Open

1

Total

47

Closed

46

Issues

Open

0

Total

11

Closed

11

Releases

1

0.2.9

v0.2.9

Published on 26 Oct 2018

View all 1 releases

Contributors

2

Unable to fetch Contributors

View all 2 contributors

Languages

5

Vue

JavaScript

SCSS

HTML

Procfile

Vue (68.82%)

JavaScript (27.44%)

SCSS (3%)

HTML (0.7%)

Procfile (0.05%)

Developer

surveylegend

Download Statistics

Total Downloads

13,692

Last Day

8

Last Week

25

Last Month

108

Last Year

1,319

GitHub Statistics

64 Stars

617 Commits

11 Forks

9 Watching

6 Branches

2 Contributors

Bundle Size

165.94 kB

Minified

46.72 kB

Minified + Gzipped

Bundlephobia

Maintainers

3

Package Meta Information

Latest Version

3.0.0

Package Id

@surveylegend/hapi-docs@3.0.0

Unpacked Size

1.99 MB

Size

568.58 kB

File Count

30

NPM Version

9.6.6

Node Version

18.11.0

Publised On

09 May 2023

Total Downloads

Cumulative downloads

Total Downloads

13,692

Last day

700%

8

Compared to previous day

Last week

-58.3%

25

Compared to previous week

Last month

61.2%

108

Compared to previous month

Last year

-37.2%

1,319

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

8

@hapi/hoek joi js-cookie marked prismjs vue vue-prism-component vuex

Peer Dependencies

1

@hapi/hapi

Dev Dependencies

19

@hapi/hapi @hapi/inert @vue/cli-plugin-eslint @vue/cli-service @vue/eslint-config-standard eslint eslint-config-prettier eslint-plugin-import eslint-plugin-node eslint-plugin-prettier eslint-plugin-promise eslint-plugin-vue nodemon prettier sass sass-loader svg-url-loader vue-template-compiler webpack

Versions

Introduction
Features
Installation
Usage
Demo
Documentation

Introduction

NOTE: Version 3.x of this project is in pure ESM and can not be used in CommonJS projects. If you want to use this project in a CommonJS project, please use v2.x. Version 2 and 3 are at feature parity, it's jst the imports and exports that differ. This is to support those who have not made the switch to ESM yet.

hapi-docs is perhaps the best and most modern API Documentation Generator out there. From your code blocks to description texts, you simply type everything in Markdown. Then all you need to do is to enjoy a blazing fast single-page responsive documentation, which smartly supports linkability, Syntax highlighting, RTL languages, and perfectionist eyes. hapi-docs is an open-source library brought to you by SurveyLegend®.

Features

Intuitive design — Inspired by Stripe’s API docs. The description of your API resides on the left part of the documentation, while all of the code examples reside on the right. Of course the layout is fully responsive and flawlessly adapts to tablets and phones.
Single page — The whole documentation resides on a single page, without sacrificing linkability. As you scroll through the documentation, your browser’s hash will update to the nearest section, which means linking to a particular point in the documentation remains natural and easy.
Scroll spy — Thanks to our custom and optimized scroll spy script, the far left navigation will smartly display your current position in the documentation, while scrolling through the documentation. It's swift and remains excellent even for larger documents.
Dark theme — Seamless switching between light and dark theme using a toggle. Supports prefers-color-scheme media query for automatic switching as well.
Markdown support — Use Markdown to describe your API. Markdown makes it easy to articulate your documentation.
Code examples in multiple languages — Configurable support for multiple languages. Easily choose which language to currently display in your documentation by switching between tabs.
Syntax highlighting — Supports over 100 languages out of the box.
RTL Support — Full Right-to-Left support for languages such as Arabic, Persian (Farsi), Hebrew, etc.
Anchor tags — With one click, users can easily link to a parameter, thanks to auto generated anchor tags.

Installation

This package can be used in hapi v19 or higher.

You can install the package via yarn:

1$ yarn add @surveylegend/hapi-docs

Usage

Note Inert is a required dependency for hapi-docs to work properly.

1import Hapi from '@hapi/hapi'
2import Inert from '@hapi/inert'
3import Joi from 'joi'
4import HapiDocs from '@surveylegend/hapi-docs'
5import { version } from './package'
6
7const options = {
8    info: {
9        title: 'Test API Reference',
10        version
11    }
12}
13
14const startServer = async () => {
15    const server = Hapi.server({
16        host: 'localhost',
17        port: 3000
18    })
19
20    await server.register([
21        {
22            plugin: Inert
23        },
24        {
25            plugin: HapiDocs,
26            options
27        }
28    ])
29
30    await server.start()
31
32    console.log(`Server listening on ${server.info.uri}`)
33}
34
35startServer().catch(console.error)

Demo

You can see a live demo version of hapi-docs. Check it out at hapi-docs

Documentation

Plugin Options

endpoint: (string) The path of the documentation - default: /docs
basePath: (string) The base path before the API, i.e. /v2 - default: /
templatePath: (string) The absolute path to the template folder, i.e. /template
host: (string) The hostname or IP serving the API, i.e. localhost:3000
scheme: (string) The transfer protocol of the API, i.e. http, https
pathPrefixSize: (number) The segment of the URL path that is used to group endpoints - default: 1
sortTags: (string) The sort method for groups, i.e. name, ordered - default: name
sortEndpoints: (string) The sort method for endpoints, i.e. path, method, ordered - default: path
info
- title: (string) The title of the documentation - default: API Reference
- version: (string) The version number of the API - default: 0.0.1
- descriptions: (array) The description of the API.
tags: (array) Contains tag objects
- name: (string) The name of the group.
- descriptions: (array) The description of the group.
- order: (int) The order which groups are sorted by.
- deprecated: (boolean) Whether a group is deprecated - default: false
- internal: (boolean) Whether a group is internal - default: false
- uppercase: (boolean) Whether a group name is uppercase - default: false
errors:
- descriptions: (array) The description of the errors.
- codes: (array) Contains error code objects
  - status: (string) The status of the error code, i.e. 418 - I'm A Teapot
  - description: (string) The description of the error code.
auth: (boolean, string or object) The security strategy used for plugin resources - default: false

Route Options

order: (int) The order which endpoints are sorted by.
deprecated: (boolean) Whether an endpoint is deprecated - default: false
internal: (boolean) Whether an endpoint is internal - default: false

Tagging API Routes

If you want a route to appear in the documentation, you have to set tags: [api] for this specific route.

Here is an example snippet of a route option:

1{
2  method: 'GET',
3  path: '/route',
4  options: {
5    handler: [...],
6    [...]
7    tags: ['api']
8  }
9}

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security-related issues, please email henrik@surveylegend.com instead of using the issue tracker.

Credits

Developed and designed by:

hapi-docs is inspired by hapi-swagger, lout, and Stripe’s API docs; and fully sponsored by SurveyLegend®.

License

The MIT License (MIT). Please see License File for more information.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

SAST

Determines if the project uses static code analysis.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @surveylegend/hapi-docs

@surveylegend/hapi-docs

Installations

Developer Guide

No

ESM

>=14

18.11.0

9.6.6

Score

Pull Requests

1

47

46

Issues

0

11

11

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

surveylegend

Download Statistics

GitHub Statistics

Bundle Size

165.94 kB

46.72 kB

Maintainers

Package Meta Information

Total Downloads

13,692

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Introduction

Features

Installation

Usage

Demo

Documentation

Plugin Options

Route Options

Tagging API Routes

Contributing

Security

Credits

License

10

10

0

0

0

0

0

0

0

0

1.7

/10