{"id":20901557,"url":"https://github.com/willfarrell/apidoc-plugin-example","last_synced_at":"2025-05-13T03:30:47.535Z","repository":{"id":57182025,"uuid":"61440987","full_name":"willfarrell/apidoc-plugin-example","owner":"willfarrell","description":"@apiExample","archived":false,"fork":false,"pushed_at":"2019-03-21T21:13:10.000Z","size":10,"stargazers_count":4,"open_issues_count":5,"forks_count":8,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-20T17:42:03.291Z","etag":null,"topics":["apidoc","apidoc-plugin"],"latest_commit_sha":null,"homepage":"","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-06-18T15:53:33.000Z","updated_at":"2020-02-24T09:43:05.000Z","dependencies_parsed_at":"2022-09-14T06:00:17.147Z","dependency_job_id":null,"html_url":"https://github.com/willfarrell/apidoc-plugin-example","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willfarrell%2Fapidoc-plugin-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willfarrell%2Fapidoc-plugin-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willfarrell%2Fapidoc-plugin-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willfarrell%2Fapidoc-plugin-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/willfarrell","download_url":"https://codeload.github.com/willfarrell/apidoc-plugin-example/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253867337,"owners_count":21976204,"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","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":["apidoc","apidoc-plugin"],"created_at":"2024-11-18T11:35:58.575Z","updated_at":"2025-05-13T03:30:47.258Z","avatar_url":"https://github.com/willfarrell.png","language":"JavaScript","readme":"# apidoc-plugin-example\n\nGenerates and inject [apidoc](http://apidocjs.com/) example elements from api schemas or files.\n\n`@apiExample {SCHEMA_TYPE=PATH_TO_SCHEMA} ELEMENT_TYPE TITLE`\n\n## Install\n`npm install apidoc-plugin-example --save-dev`\n\n## Supported Schema Types\n### json\nPrettifies JSON and injects in.\n\n### [jsonschema](https://json-schema.org)\nUses [json-schema-faker](https://github.com/json-schema-faker/json-schema-faker) to generate a sample response.\n\n\n## Example Use\n```javascript\n/**\n * @api {get} /api GetAPI\n * @apiExample {json=./ex/api.req.json} apiParamExample Request\n * @apiExample {jsonschema=./ex/api.res.json} apiSuccessExample Response JSON\n * @apiExample {xml=./ex/api.res.xml} apiSuccessExample Response XML\n */\n```\n\n## Developer Note\nThis plugin uses `parser-find-elements` @ priority `201`.\n\n## TODO\n- Add in wsdl schema / XSD\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillfarrell%2Fapidoc-plugin-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwillfarrell%2Fapidoc-plugin-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillfarrell%2Fapidoc-plugin-example/lists"}