{"id":20348466,"url":"https://github.com/onebeyond/swagger-endpoint-validator","last_synced_at":"2025-04-12T01:14:26.406Z","repository":{"id":35494930,"uuid":"218011904","full_name":"onebeyond/swagger-endpoint-validator","owner":"onebeyond","description":"Validator around swagger generator","archived":false,"fork":false,"pushed_at":"2024-06-16T10:08:09.000Z","size":1843,"stargazers_count":7,"open_issues_count":7,"forks_count":1,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-12T01:14:20.030Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"https://onebeyond.github.io/swagger-endpoint-validator/","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/onebeyond.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-28T09:35:52.000Z","updated_at":"2023-04-11T15:27:30.000Z","dependencies_parsed_at":"2024-04-01T16:31:26.128Z","dependency_job_id":null,"html_url":"https://github.com/onebeyond/swagger-endpoint-validator","commit_stats":null,"previous_names":["guidesmiths/swagger-endpoint-validator"],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onebeyond%2Fswagger-endpoint-validator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onebeyond%2Fswagger-endpoint-validator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onebeyond%2Fswagger-endpoint-validator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onebeyond%2Fswagger-endpoint-validator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/onebeyond","download_url":"https://codeload.github.com/onebeyond/swagger-endpoint-validator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248501861,"owners_count":21114684,"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":["hacktoberfest"],"created_at":"2024-11-14T22:20:33.172Z","updated_at":"2025-04-12T01:14:26.376Z","avatar_url":"https://github.com/onebeyond.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n[![CI](https://github.com/guidesmiths/swagger-endpoint-validator/actions/workflows/ci.yml/badge.svg)](https://github.com/guidesmiths/swagger-endpoint-validator/actions/workflows/ci.yml)\n[![CD](https://github.com/guidesmiths/swagger-endpoint-validator/actions/workflows/cd.yml/badge.svg)](https://github.com/guidesmiths/swagger-endpoint-validator/actions/workflows/cd.yml)\n[![Maintainability](https://api.codeclimate.com/v1/badges/08258af73b9f938e544a/maintainability)](https://codeclimate.com/github/onebeyond/swagger-endpoint-validator/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/08258af73b9f938e544a/test_coverage)](https://codeclimate.com/github/onebeyond/swagger-endpoint-validator/test_coverage)\n\n# swagger-endpoint-validator\n\n![npm](https://img.shields.io/npm/v/swagger-endpoint-validator)\n\nA validator of API endpoints to check that input and/or output match with the swagger specification for the API.\n\nThis is based on [express-swagger-generator](https://www.npmjs.com/package/express-swagger-generator), so it is important that each endpoints is properly documented so that the library can do the validation.\n\n## Installation\n\n```bash\nnpm install --save swagger-endpoint-validator\n```\n\n## Methods\n\n### init(app: ExpressApp, options: ConfigFile)\n\n```js\nawait validator.init(app, options);\n```\n\nwhere:\n\n  - `app` is the Express app instance.\n  - `options` is the configuration object used by the validator.\n\n## TO DO!\n\nImprove this doc.\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/kevinccbsg\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/12685053?v=4?s=100\" width=\"100px;\" alt=\"Kevin Julián Martínez Escobar\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eKevin Julián Martínez Escobar\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/issues?q=author%3Akevinccbsg\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e \u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/commits?author=kevinccbsg\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/commits?author=kevinccbsg\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#ideas-kevinccbsg\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/pulls?q=is%3Apr+reviewed-by%3Akevinccbsg\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e \u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/commits?author=kevinccbsg\" title=\"Tests\"\u003e⚠️\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/LonelyPrincess\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/17673317?v=4?s=100\" width=\"100px;\" alt=\"Sara Hernández\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eSara Hernández\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/issues?q=author%3ALonelyPrincess\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e \u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/commits?author=LonelyPrincess\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://www.linkedin.com/in/irenemateoh-fullstack/\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/39806058?v=4?s=100\" width=\"100px;\" alt=\"Irene Mateo Herrero\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eIrene Mateo Herrero\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/commits?author=irenemherrero\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/inigomarquinez\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/25435858?v=4?s=100\" width=\"100px;\" alt=\"Íñigo Marquínez Prado\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eÍñigo Marquínez Prado\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/issues?q=author%3Ainigomarquinez\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e \u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/commits?author=inigomarquinez\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/commits?author=inigomarquinez\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#ideas-inigomarquinez\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"#maintenance-inigomarquinez\" title=\"Maintenance\"\u003e🚧\u003c/a\u003e \u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/pulls?q=is%3Apr+reviewed-by%3Ainigomarquinez\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e \u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/commits?author=inigomarquinez\" title=\"Tests\"\u003e⚠️\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://ulisesgascon.com/\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/5110813?v=4?s=100\" width=\"100px;\" alt=\"Ulises Gascón\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eUlises Gascón\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/issues?q=author%3AUlisesGascon\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e \u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/commits?author=UlisesGascon\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/commits?author=UlisesGascon\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#ideas-UlisesGascon\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"#maintenance-UlisesGascon\" title=\"Maintenance\"\u003e🚧\u003c/a\u003e \u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/pulls?q=is%3Apr+reviewed-by%3AUlisesGascon\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e \u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/commits?author=UlisesGascon\" title=\"Tests\"\u003e⚠️\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/neodmy\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/36865163?v=4?s=100\" width=\"100px;\" alt=\"David Miguel Yusta\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eDavid Miguel Yusta\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/commits?author=neodmy\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/onebeyond/swagger-endpoint-validator/commits?author=neodmy\" title=\"Tests\"\u003e⚠️\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonebeyond%2Fswagger-endpoint-validator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fonebeyond%2Fswagger-endpoint-validator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonebeyond%2Fswagger-endpoint-validator/lists"}