🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

apidoc-plugin-ts

Package Overview
Dependencies
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

apidoc-plugin-ts

A plugin for apidoc leveraging TypeScript interfaces.

0.1.5
latest
npm
Version published
Weekly downloads
12
-70.73%
Maintainers
1
Weekly downloads
 
Created
Source

apidoc-plugin-ts

A plugin for apidoc that injects @apiSuccess params from TypeScript interfaces. Supports extended and nested interfaces.

Getting started

npm install --save-dev apidoc apidoc-plugin-ts

A custom api-doc param "@apiInterface" is exposed:

@apiInterface (optional path) {INTERFACE_NAME} REPLACE-API-PARAM

Example

Given the following interface:

filename: ./employers.ts

export interface Employer {
  /**
   * Employer job title
   */
  jobTitle: string;
  /**
   * Employer personal details
   */
  personalDetails: {
    name: string;
    age: number;
  }
}

and the following custom param:

 @apiInterface (./employers.ts) {Person}

under the hood this would transpile to:

 @apiSuccess {String} jobTitle Job title
 @apiSuccess {Object} personalDetails Empoyer personal details
 @apiSuccess {String} personalDetails.name
 @apiSuccess {Number} personalDetails.age

Notes

  • If the Person interface is defined in the same file then drop the path e.g @apiInterface {Person}.
  • REPLACE-API-PARAM is optional and defaults to apiSuccess.

Keywords

apidoc

FAQs

Package last updated on 07 Dec 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts