apidoc-plugin-schema2

apidoc-plugin-schema2

Generates and inject apidoc elements from api schemas.

@apiSchema [(group)] {SCHEMA_TYPE=PATH_TO_SCHEMA} ELEMENT_TYPE

Install

npm add --include=dev apidoc-plugin-schema

Supported Schemas

jsonschema

• description
• type
• array: items
• object: properties,required
• integer: minimum,maximum
• number: minLength,maxLength
• enum
• default
• auto groups object of array/object

Example Use

/**
 * @api {get} /api GetAPI
 * @apiSchema (Body) {jsonschema=./schema/api.req.json} apiParam
 * @apiSchema {jsonschema=./schema/api.res.json} apiSuccess
 */

Developer Note

This plugin uses parser-find-elements @ priority 201.

TODO

• Add in unit test for jsonschema
• Add in travis-ci
• add in xml/wsdl schema type

jsonschema

• add in support for exclusive number ranges
• add support for "oneOf":[{"required":[...]},...]
• add support for "oneOf":[{"type":"string"},...]
• add support for allOf