{"id":13474720,"url":"https://github.com/willfarrell/apidoc-plugin-schema","last_synced_at":"2025-09-25T20:25:12.767Z","repository":{"id":46687403,"uuid":"56339938","full_name":"willfarrell/apidoc-plugin-schema","owner":"willfarrell","description":"@apiSchema Plugin for apidoc","archived":false,"fork":false,"pushed_at":"2021-09-30T00:35:54.000Z","size":31,"stargazers_count":32,"open_issues_count":6,"forks_count":16,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-23T06:45:00.970Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/willfarrell.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-04-15T18:01:36.000Z","updated_at":"2023-08-26T18:07:01.000Z","dependencies_parsed_at":"2022-09-13T15:25:40.633Z","dependency_job_id":null,"html_url":"https://github.com/willfarrell/apidoc-plugin-schema","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/willfarrell/apidoc-plugin-schema","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willfarrell%2Fapidoc-plugin-schema","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willfarrell%2Fapidoc-plugin-schema/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willfarrell%2Fapidoc-plugin-schema/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willfarrell%2Fapidoc-plugin-schema/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/willfarrell","download_url":"https://codeload.github.com/willfarrell/apidoc-plugin-schema/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willfarrell%2Fapidoc-plugin-schema/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276976279,"owners_count":25738650,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-25T02:00:09.612Z","response_time":80,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T16:01:14.311Z","updated_at":"2025-09-25T20:25:12.714Z","avatar_url":"https://github.com/willfarrell.png","language":"JavaScript","readme":"# apidoc-plugin-schema\n\nGenerates and inject [apidoc](http://apidoc.com) elements from api schemas.\n\n`@apiSchema [(group)] {SCHEMA_TYPE=PATH_TO_SCHEMA} ELEMENT_TYPE`\n\n## Install\n`npm install apidoc-plugin-schema --save-dev`\n\n## Supported Schemas\n### [jsonschema](http://json-schema.org)\n- `description`\n- `type`\n - `array`: `items`\n - `object`: `properties`,`required`\n - `integer`: `minimum`,`maximum`\n - `number`: `minLength`,`maxLength`\n- `enum`\n- `default`\n- auto groups object of array/object\n\n## Example Use\n```javascript\n/**\n * @api {get} /api GetAPI\n * @apiSchema (Body) {jsonschema=./schema/api.req.json} apiParam\n * @apiSchema {jsonschema=./schema/api.res.json} apiSuccess\n */\n```\n\n## Developer Note\nThis plugin uses `parser-find-elements` @ priority `201`.\n\n## TODO\n- Add in unit test for jsonschema\n- Add in travis-ci\n- add in xml/wsdl schema type\n\n### jsonschema\n- add in support for exclusive number ranges\n- add support for `\"oneOf\":[{\"required\":[...]},...]`\n- add support for `\"oneOf\":[{\"type\":\"string\"},...]`\n- add support for `allOf`\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillfarrell%2Fapidoc-plugin-schema","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwillfarrell%2Fapidoc-plugin-schema","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillfarrell%2Fapidoc-plugin-schema/lists"}