Generates and inject apidoc elements from api schemas.
@apiSchema [(group)] {SCHEMA_TYPE=PATH_TO_SCHEMA} ELEMENT_TYPE
npm install apidoc-plugin-schema --save-dev
description
type
array
: items
object
: properties
,required
integer
: minimum
,maximum
number
: minLength
,maxLength
enum
default
/**
* @api {get} /api GetAPI
* @apiSchema (Body) {jsonschema=./schema/api.req.json} apiParam
* @apiSchema {jsonschema=./schema/api.res.json} apiSuccess
*/
This plugin uses parser-find-elements
@ priority 201
.
"oneOf":[{"required":[...]},...]
"oneOf":[{"type":"string"},...]
allOf