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
- auto groups object of array/object
/**
* @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
.
- Add in unit test for jsonschema
- Add in travis-ci
- add in xml/wsdl schema type
- add in support for exclusive number ranges
- add support for
"oneOf":[{"required":[...]},...]
- add support for
"oneOf":[{"type":"string"},...]
- add support for
allOf