{"id":13879152,"url":"https://github.com/kymmt90/schema_conformist","last_synced_at":"2025-11-11T18:32:01.867Z","repository":{"id":49004614,"uuid":"109483344","full_name":"kymmt90/schema_conformist","owner":"kymmt90","description":"An automatic JSON response validator for testing in Rails","archived":false,"fork":false,"pushed_at":"2021-07-01T09:19:38.000Z","size":122,"stargazers_count":30,"open_issues_count":1,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-04T14:03:33.689Z","etag":null,"topics":["json-hyper-schema","json-schema","openapi","rails","rspec","ruby","swagger"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/kymmt90.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"MIT-LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-04T09:45:52.000Z","updated_at":"2023-06-19T05:33:12.000Z","dependencies_parsed_at":"2022-09-07T14:01:15.747Z","dependency_job_id":null,"html_url":"https://github.com/kymmt90/schema_conformist","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/kymmt90%2Fschema_conformist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kymmt90%2Fschema_conformist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kymmt90%2Fschema_conformist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kymmt90%2Fschema_conformist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kymmt90","download_url":"https://codeload.github.com/kymmt90/schema_conformist/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248644185,"owners_count":21138565,"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":["json-hyper-schema","json-schema","openapi","rails","rspec","ruby","swagger"],"created_at":"2024-08-06T08:02:11.464Z","updated_at":"2025-11-11T18:31:56.834Z","avatar_url":"https://github.com/kymmt90.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# SchemaConformist\n\n[![Gem Version](https://badge.fury.io/rb/schema_conformist.svg)](https://badge.fury.io/rb/schema_conformist) [![Build Status](https://github.com/kymmt90/schema_conformist/workflows/build/badge.svg)](https://github.com/kymmt90/schema_conformist/actions?workflow=build)\n\n\u003e An automatic JSON request/response validator for testing in Rails\n\nSchemaConformist is an automatic JSON request/response validator for your API testing in Rails.\n\nThis library automatically validates that JSON requests/responses are conformant with the schema. The schema can be described as one of [JSON Hyper Schema](http://json-schema.org/latest/json-schema-hypermedia.html), [OpenAPI 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) and OpenAPI 3 (currently [3.0.2](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md) is latest).\n\nThis library uses [Committee](https://github.com/interagent/committee) to validate JSONs.\n\n## Usage\n\n### Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'schema_conformist'\n```\n\nand execute `bundle install`.\n\nConfigure `schema_path` as follows (ex. using an OpenAPI 3 schema):\n\n```ruby\nRails.application.config.schema_conformist.schema_path = Rails.root.join('doc', 'openapi.yaml')\n```\n\nThat's all. Then all JSON requests/responses in integration-test/request-spec are validated according to your schema.\n\n### Writing the Schema\n\nWrite your API schema in one of JSON Hyper Schema, OpenAPI 2 and OpenAPI 3.\n\nSee [`test/dummy`](https://github.com/kymmt90/schema_conformist/tree/master/test/dummy) app for examples.\n\n### Configurations\n\nConfiguration options are following:\n\n- `schema_conformist.schema_path`\n  - Required. The path where the schema is placed\n- `schema_conformist.ignored_api_paths`\n  - Optional. The array of API paths not to validate. Each path can be described in String literal (used for prefix search) or regular expression.\n- `schema_conformist.committee.old_assert_behavior`\n  - Optional. Set `true` if you want to skip validating request parameters. The default value is `false`.\n  - cf. [\"Test Assertions\" in Committee README](https://github.com/interagent/committee#test-assertions)\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/kymmt90/schema_conformist.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkymmt90%2Fschema_conformist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkymmt90%2Fschema_conformist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkymmt90%2Fschema_conformist/lists"}