{"id":27283951,"url":"https://github.com/sylvainlaurent/swagger-validator-maven-plugin","last_synced_at":"2025-04-11T18:47:14.007Z","repository":{"id":57723467,"uuid":"53534636","full_name":"sylvainlaurent/swagger-validator-maven-plugin","owner":"sylvainlaurent","description":"A maven plugin that validates swagger files in yaml and json formats","archived":false,"fork":false,"pushed_at":"2023-09-26T19:43:36.000Z","size":220,"stargazers_count":11,"open_issues_count":9,"forks_count":6,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-04-16T11:00:25.259Z","etag":null,"topics":["maven-plugin","openapi-validation","swagger"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sylvainlaurent.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-03-09T21:53:53.000Z","updated_at":"2024-04-16T11:00:25.259Z","dependencies_parsed_at":"2022-08-28T15:33:48.891Z","dependency_job_id":null,"html_url":"https://github.com/sylvainlaurent/swagger-validator-maven-plugin","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sylvainlaurent%2Fswagger-validator-maven-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sylvainlaurent%2Fswagger-validator-maven-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sylvainlaurent%2Fswagger-validator-maven-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sylvainlaurent%2Fswagger-validator-maven-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sylvainlaurent","download_url":"https://codeload.github.com/sylvainlaurent/swagger-validator-maven-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248462320,"owners_count":21107849,"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":["maven-plugin","openapi-validation","swagger"],"created_at":"2025-04-11T18:47:11.914Z","updated_at":"2025-04-11T18:47:13.999Z","avatar_url":"https://github.com/sylvainlaurent.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/sylvainlaurent/swagger-validator-maven-plugin.svg)](https://travis-ci.org/sylvainlaurent/swagger-validator-maven-plugin)\n\n# swagger-validator-maven-plugin\n\nThis maven plugin allows to validate yaml and json files.\n\n## Plugin configuration\n\n```xml\n      \u003cplugin\u003e\n        \u003cgroupId\u003ecom.github.sylvainlaurent.maven\u003c/groupId\u003e\n        \u003cartifactId\u003eswagger-validator-maven-plugin\u003c/artifactId\u003e\n        \u003cversion\u003e...\u003c/version\u003e\n        \u003cexecutions\u003e\n          \u003cexecution\u003e\n            \u003cid\u003evalidate\u003c/id\u003e\n            \u003cphase\u003evalidate\u003c/phase\u003e\n            \u003cgoals\u003e\n              \u003cgoal\u003evalidate\u003c/goal\u003e\n            \u003c/goals\u003e\n            \u003cconfiguration\u003e\n                \u003cfailOnErrors\u003etrue\u003c/failOnErrors\u003e\n              \u003cincludes\u003e\n                \u003cinclude\u003esrc/main/resources/swagger-*.yml\u003c/include\u003e\n                \u003cinclude\u003esrc/main/resources/swagger-*.json\u003c/include\u003e\n                \u003c!-- other \u003cinclude\u003e may be added --\u003e\n              \u003c/includes\u003e\n              \u003cexcludes\u003e\n                \u003cexclude\u003esrc/main/resources/swagger-do-not-validate*.yml\u003c/exclude\u003e\n                \u003c!-- \u003cexclude\u003e is optional, others may be added --\u003e\n              \u003c/excludes\u003e\n              \u003c!-- package names where custom validators are located --\u003e\n              \u003ccustomModelValidatorsPackage\u003ecom.example.validators\u003c/customValidatorsPackage\u003e\n              \u003ccustomPathValidatorsPackage\u003ecom.example.validators\u003c/customPathValidatorsPackage\u003e\n            \u003c/configuration\u003e\n          \u003c/execution\u003e\n        \u003c/executions\u003e\n        \u003cdependencies\u003e\n            \u003c!-- dependency with custom validators --\u003e\n            \u003cdependency\u003e\n                \u003cgroupId\u003ecom.example\u003c/groupId\u003e\n                \u003cartifactId\u003ecustom-validators\u003c/artifactId\u003e\n                \u003cversion\u003e${project.version}\u003c/version\u003e\n            \u003c/dependency\u003e\n        \u003c/dependencies\u003e\n      \u003c/plugin\u003e\n```\n\nValidation failures make the build fail but default. You can change this by setting `\u003cfailOnErrors\u003efalse\u003c/failOnErrors\u003e`.\n\nYou can add your custom validators and provide plugin with them. Extend from ModelValidatorTemplate or PathValidatorTemplate \nclasses for writing your validators and override necessary validation methods. See ReferenceValidator and PathValidator as examples.\n\nRequires java 1.8.\n\n## Source code\nThe source code is available on GitHub : https://github.com/sylvainlaurent/swagger-validator-maven-plugin\n\n### How to build source\nUse Maven and a JDK \u003e=8, and run `mvn clean verify` in the root directory of the git repository.\n\n### How to create a release\n`mvn release:prepare release:perform` and answer the questions about version number.\n\nThen push the commits and tags to github.\n\n## License\nThis software is licensed under the Apache Sotware License version 2.0, see [LICENSE.txt](LICENSE.txt).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsylvainlaurent%2Fswagger-validator-maven-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsylvainlaurent%2Fswagger-validator-maven-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsylvainlaurent%2Fswagger-validator-maven-plugin/lists"}