{"id":17419682,"url":"https://github.com/bendrucker/swagger-parameters","last_synced_at":"2025-07-21T04:31:56.949Z","repository":{"id":57375870,"uuid":"64716245","full_name":"bendrucker/swagger-parameters","owner":"bendrucker","description":"Validate and parse request data using swagger parameters arrays","archived":false,"fork":false,"pushed_at":"2019-08-19T23:36:54.000Z","size":13,"stargazers_count":9,"open_issues_count":2,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-17T17:28:28.715Z","etag":null,"topics":[],"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/bendrucker.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-08-02T02:11:02.000Z","updated_at":"2020-07-31T12:07:27.000Z","dependencies_parsed_at":"2022-09-02T19:32:02.276Z","dependency_job_id":null,"html_url":"https://github.com/bendrucker/swagger-parameters","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bendrucker%2Fswagger-parameters","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bendrucker%2Fswagger-parameters/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bendrucker%2Fswagger-parameters/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bendrucker%2Fswagger-parameters/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bendrucker","download_url":"https://codeload.github.com/bendrucker/swagger-parameters/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226867826,"owners_count":17694818,"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":[],"created_at":"2024-10-17T02:29:22.491Z","updated_at":"2024-11-28T06:17:01.633Z","avatar_url":"https://github.com/bendrucker.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# swagger-parameters [![Build Status](https://travis-ci.org/bendrucker/swagger-parameters.svg?branch=master)](https://travis-ci.org/bendrucker/swagger-parameters) [![Greenkeeper badge](https://badges.greenkeeper.io/bendrucker/swagger-parameters.svg)](https://greenkeeper.io/)\n\n\u003e Validate and parse request data using swagger parameters arrays\n\nswagger-parameters turns your [Swagger/OpenAPI parameters](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameterObject) into a full JSON schema that can be used to parse and validate HTTP request data. The library is fully server-agnostic. You're responsible for converting your request paths and queries into key-value data. swagger-parameters will perform validation and type coercion and return a copy of your parsed data (if valid).\n\n## Install\n\n```\n$ npm install --save swagger-parameters\n```\n\n\n## Usage\n\n```js\nvar Parser = require('swagger-parameters')\n// var Schema = require('swagger-parameters/schema')\n\n// /users/{id}/orders?page={page}\nvar parse = Parser([\n  {\n    name: 'id',\n    in: 'path',\n    type: 'integer',\n    required: true\n  },\n  {\n    name: 'page',\n    in: 'query',\n    default: 1,\n    type: 'integer'\n  },\n  {\n    name: 'token',\n    in: 'header',\n    required: true\n  }\n])\n\nparse({\n  path: {id: '1'},\n  query: {page: '5'},\n  headers: {token: 't'}\n}, function (err, data) {\n  if (err) throw err\n  console.log(data)\n  //=\u003e {path: {id: 1}, query: {page: 5}, headers: {token: 't'}}\n})\n```\n\n## API\n\n#### `Parser(parameters, [data])` -\u003e `function\u003cparse\u003e`\n\n##### parameters\n\nType: `array[object]`  \nDefault: `[]`\n\nAn array of Swagger/OpenAPI [parameter definition](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameters-definitions-object).\n\n##### data\n\n*Required*  \nType: `object`\n\nData that can be resolved by `$ref` parameters.\n\n#### `parse(data, callback)` -\u003e `undefined`\n\n##### data\n\n*Required*  \nType: `object`\n\nA `{path, query, headers}` object, each with key-value data.\n\n##### callback\n\n*Required*  \nType: `function`  \nArguments: `err, data`\n\nA callback to be called with a validation error or a parsed copy of the data. Validation errors will have an `errors` property which is an array of JSON schema error objects from [ajv](https://github.com/epoberezkin/ajv).\n\n\n## License\n\nMIT © [Ben Drucker](http://bendrucker.me)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbendrucker%2Fswagger-parameters","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbendrucker%2Fswagger-parameters","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbendrucker%2Fswagger-parameters/lists"}