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:
@ {INTERFACE_NAME} REPLACE-API-PARAM
Example
Given the following interface:
filename: /employersts }
and the following custom param:
@ {Person}
under the hood this would transpile to:
@apiSuccess String jobTitle Job title @apiSuccess Object personalDetails Empoyer personal details @apiSuccess String personalDetailsname @apiSuccess Number personalDetailsage
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.