# apidoc-plugin-schema2

> JSON Schema Plugin for apidoc.

Latest version **0.1.8** (published 2021-09-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install apidoc-plugin-schema2
pnpm add apidoc-plugin-schema2
yarn add apidoc-plugin-schema2
bun add apidoc-plugin-schema2
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.8 |
| Published | 2021-09-30 |
| First published | 2021-09-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=16 |
| Dependencies | 2 |
| Unpacked size | 11.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | ingalls |
| Keywords | apidoc, apidoc-plugin, apidoc-plugin-jsonschema, jsonschema |

## Links

- npm: https://www.npmjs.com/package/apidoc-plugin-schema2
- Repository: https://github.com/ingalls/apidoc-plugin-jsonschema
- Homepage: https://github.com/ingalls/apidoc-plugin-jsonschema#readme
- Issues: https://github.com/ingalls/apidoc-plugin-jsonschema/issues
- npm.io page: https://npm.io/package/apidoc-plugin-schema2

## Dependencies (2)

- [deasync-promise](https://npm.io/package/deasync-promise.md) 1.0.1
- [json-schema-ref-parser](https://npm.io/package/json-schema-ref-parser.md) ^9.0.7

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.1.8 (latest) — 2021-09-30

## README

<h1 align=center>apidoc-plugin-schema2</h1>

Generates and inject [apidoc](http://apidoc.com) elements from api schemas.

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

## Install

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

## Supported Schemas

### [jsonschema](http://json-schema.org)
- `description`
- `type`
 - `array`: `items`
 - `object`: `properties`,`required`
 - `integer`: `minimum`,`maximum`
 - `number`: `minLength`,`maxLength`
- `enum`
- `default`
- auto groups object of array/object

## Example Use

```javascript
/**
 * @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`

---
_Source: https://npm.io/package/apidoc-plugin-schema2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
