openapi_first
openapi_first is a Ruby gem for request / response validation and contract-testing against an OpenAPI API description. It makes APIFirst easy and reliable.
File Explorer
Download Latest Version (.zip)- codeql.yml
- ruby.yml
- CODEOWNERS
- app.rb
- committee.ru
- committee_with_response_validation.ru
- openapi.yaml
- openapi_first.ru
- openapi_first_with_response_validation.ru
- benchmark-wrk.sh
- benchmarks.rb
- Gemfile
- Gemfile.lock
- large.rb
- load_only.rb
- post.lua
- profile.rb
- README.md
- console
- setup
- update
- channel.rb
- connection.rb
- .keep
- application_controller.rb
- attachments_controller.rb
- bookings_controller.rb
- stations_controller.rb
- trips_controller.rb
- application_job.rb
- application_mailer.rb
- .keep
- mailer.html.erb
- mailer.text.erb
- bundle
- docker-entrypoint
- rails
- rake
- setup
- development.rb
- production.rb
- test.rb
- cors.rb
- filter_parameter_logging.rb
- inflections.rb
- en.yml
- application.rb
- boot.rb
- cable.yml
- credentials.yml.enc
- environment.rb
- puma.rb
- routes.rb
- weather_manifest.js
- .keep
- application.css
- .keep
- application_controller.rb
- temperature_controller.rb
- application_helper.rb
- application_job.rb
- application_mailer.rb
- .keep
- application_record.rb
- application.html.erb
- rails
- rubocop
- routes.rb
- weather_tasks.rake
- engine.rb
- version.rb
- weather.rb
- .keep
- temperature_controller_test.rb
- manifest.js
- .keep
- application.css
- channel.rb
- connection.rb
- .keep
- application_controller.rb
- application_helper.rb
- application_job.rb
- application_mailer.rb
- .keep
- application_record.rb
- application.html.erb
- mailer.html.erb
- mailer.text.erb
- manifest.json.erb
- service-worker.js
- rails
- rake
- setup
- development.rb
- production.rb
- test.rb
- assets.rb
- content_security_policy.rb
- filter_parameter_logging.rb
- inflections.rb
- permissions_policy.rb
- en.yml
- application.rb
- boot.rb
- cable.yml
- database.yml
- environment.rb
- puma.rb
- routes.rb
- storage.yml
- .keep
- .keep
- 404.html
- 406-unsupported-browser.html
- 422.html
- 500.html
- icon.png
- icon.svg
- .keep
- .keep
- .keep
- .keep
- config.ru
- Rakefile
- .keep
- .keep
- .keep
- navigation_test.rb
- .keep
- .keep
- weather_test.rb
- Gemfile
- Rakefile
- weather.gemspec
- .keep
- .keep
- robots.txt
- .keep
- connection_test.rb
- .keep
- bookings_controller_test.rb
- trips_controller_test.rb
- .keep
- .keep
- attachments_api_test.rb
- stations_api_test.rb
- trips_api_test.rb
- .keep
- .keep
- test_helper.rb
- .keep
- .keep
- .keep
- .keep
- .dockerignore
- .gitattributes
- .gitignore
- .ruby-version
- config.ru
- Dockerfile
- Gemfile
- Gemfile.lock
- Rakefile
- README.md
- config.ru
- openapi.yaml
- rack_handler.rb
- README.md
- default.rb
- jsonapi.rb
- request_validation.rb
- response_validation.rb
- array_converter.rb
- object_converter.rb
- converter.rb
- unpackers.rb
- x_public.rb
- find_content.rb
- find_response.rb
- path_template.rb
- hash.rb
- validation_error.rb
- validation_result.rb
- context.rb
- covered_request.rb
- covered_response.rb
- html_reporter.css
- html_reporter.html.erb
- html_reporter.rb
- plan.rb
- request_task.rb
- response_task.rb
- route_task.rb
- terminal_reporter.rb
- tracker.rb
- app.rb
- callable.rb
- configuration.rb
- coverage.rb
- logger.rb
- methods.rb
- minitest_helpers.rb
- observe.rb
- observer_middleware.rb
- plain_helpers.rb
- multipart_request_body.rb
- request_body.rb
- request_parameters.rb
- response_body.rb
- response_headers.rb
- builder.rb
- child_configuration.rb
- configuration.rb
- definition.rb
- error_response.rb
- errors.rb
- failure.rb
- file_loader.rb
- json.rb
- parameter.rb
- parameter_content_parsers.rb
- parameters_parser.rb
- parsed_request.rb
- plugins.rb
- query_string_parser.rb
- ref_resolver.rb
- registry.rb
- request.rb
- request_body_parsers.rb
- request_headers.rb
- request_validator.rb
- response.rb
- response_body_parsers.rb
- response_header.rb
- response_parser.rb
- response_validator.rb
- router.rb
- sinatra.rb
- test.rb
- validated_request.rb
- validated_response.rb
- version.rb
- openapi_first.rb
- x-authors.yaml
- filter.yaml
- strings.yaml
- adog.yaml
- cat.yaml
- dog.yaml
- integers.yaml
- name.yaml
- pet.json
- pet.yaml
- pets_union.yaml
- parameters.yaml
- AddCustomFieldSettingRequest.yaml
- AddFollowersRequest.yaml
- AddMembersRequest.yaml
- AsanaNamedResource.yaml
- AsanaResource.yaml
- AttachmentBase.yaml
- AttachmentCompact.yaml
- AttachmentRequest.yaml
- AttachmentResponse.yaml
- BatchRequest.yaml
- BatchRequestAction.yaml
- BatchResponse.yaml
- CustomFieldBase.yaml
- CustomFieldCompact.yaml
- CustomFieldRequest.yaml
- CustomFieldResponse.yaml
- CustomFieldSettingBase.yaml
- CustomFieldSettingCompact.yaml
- CustomFieldSettingResponse.yaml
- EmptyResponse.yaml
- EnumOption.yaml
- EnumOptionBase.yaml
- EnumOptionInsertRequest.yaml
- EnumOptionRequest.yaml
- Error.yaml
- ErrorResponse.yaml
- EventResponse.yaml
- GoalAddSubgoalRequest.yaml
- GoalAddSupportingWorkRequest.yaml
- GoalBase.yaml
- GoalCompact.yaml
- GoalMetricBase.yaml
- GoalMetricCurrentValueRequest.yaml
- GoalMetricRequest.yaml
- GoalRemoveSubgoalRequest.yaml
- GoalRequest.yaml
- GoalResponse.yaml
- JobBase.yaml
- JobCompact.yaml
- JobResponse.yaml
- Like.yaml
- ModifyDependenciesRequest.yaml
- ModifyDependentsRequest.yaml
- OrganizationExportBase.yaml
- OrganizationExportCompact.yaml
- OrganizationExportRequest.yaml
- OrganizationExportResponse.yaml
- PortfolioAddItemRequest.yaml
- PortfolioBase.yaml
- PortfolioCompact.yaml
- PortfolioMembershipBase.yaml
- PortfolioMembershipCompact.yaml
- PortfolioMembershipResponse.yaml
- PortfolioRemoveItemRequest.yaml
- PortfolioRequest.yaml
- PortfolioResponse.yaml
- Preview.yaml
- ProjectBase.yaml
- ProjectCompact.yaml
- ProjectDuplicateRequest.yaml
- ProjectMembershipBase.yaml
- ProjectMembershipCompact.yaml
- ProjectMembershipResponse.yaml
- ProjectRequest.yaml
- ProjectResponse.yaml
- ProjectSectionInsertRequest.yaml
- ProjectStatusBase.yaml
- ProjectStatusCompact.yaml
- ProjectStatusRequest.yaml
- ProjectStatusResponse.yaml
- RemoveCustomFieldSettingRequest.yaml
- RemoveFollowersRequest.yaml
- RemoveMembersRequest.yaml
- SectionBase.yaml
- SectionCompact.yaml
- SectionRequest.yaml
- SectionResponse.yaml
- SectionTaskInsertRequest.yaml
- StoryBase.yaml
- StoryCompact.yaml
- StoryRequest.yaml
- StoryResponse.yaml
- StoryResponseDates.yaml
- TagBase.yaml
- TagCompact.yaml
- TagRequest.yaml
- TagResponse.yaml
- TaskAddFollowersRequest.yaml
- TaskAddProjectRequest.yaml
- TaskAddTagRequest.yaml
- TaskBase.yaml
- TaskCompact.yaml
- TaskCountResponse.yaml
- TaskDuplicateRequest.yaml
- TaskRemoveFollowersRequest.yaml
- TaskRemoveProjectRequest.yaml
- TaskRemoveTagRequest.yaml
- TaskRequest.yaml
- TaskResponse.yaml
- TaskSetParentRequest.yaml
- TeamAddUserRequest.yaml
- TeamBase.yaml
- TeamCompact.yaml
- TeamMembershipBase.yaml
- TeamMembershipCompact.yaml
- TeamMembershipResponse.yaml
- TeamRemoveUserRequest.yaml
- TeamRequest.yaml
- TeamResponse.yaml
- TimePeriodBase.yaml
- TimePeriodCompact.yaml
- TimePeriodResponse.yaml
- UserBase.yaml
- UserCompact.yaml
- UserResponse.yaml
- UserTaskListBase.yaml
- UserTaskListCompact.yaml
- UserTaskListResponse.yaml
- WebhookCompact.yaml
- WebhookFilter.yaml
- WebhookRequest.yaml
- WebhookResponse.yaml
- WorkspaceAddUserRequest.yaml
- WorkspaceBase.yaml
- WorkspaceCompact.yaml
- WorkspaceMembershipBase.yaml
- WorkspaceMembershipCompact.yaml
- WorkspaceMembershipResponse.yaml
- WorkspaceRemoveUserRequest.yaml
- WorkspaceRequest.yaml
- WorkspaceResponse.yaml
- RateLimit.yaml
- Retry-After.yaml
- BadRequest.yaml
- Conflict.yaml
- Forbidden.yaml
- InternalServerError.yaml
- NotFound.yaml
- TooManyRequests.yaml
- Unauthorized.yaml
- Booking.yaml
- BookingPayment.yaml
- Links-Booking.yaml
- Links-Pagination.yaml
- Links-Self.yaml
- Problem.yaml
- Station.yaml
- Trip.yaml
- Wrapper-Collection.yaml
- bookings.yaml
- bookings_{bookingId}.yaml
- bookings_{bookingId}_payment.yaml
- stations.yaml
- trips.yaml
- newBooking.yaml
- openapi.yaml
- attachments_openapi.yaml
- content-types.yaml
- cookie-parameter-validation.yaml
- dice.yaml
- discriminator-refs.yaml
- foo.txt
- fullofrefs.yaml
- header-parameter-validation.yaml
- incompatible-routes.yaml
- large.yaml
- media-type-without-schema.yaml
- no-content.yaml
- no-operation-name.yaml
- no-response-content.yaml
- nullable-string.yaml
- nullable.yaml
- numeric-status.yaml
- openapi-3.2.yaml
- operation-id-missing.yaml
- parameters-array.yaml
- parameters-flat.yaml
- parameters-mix-issue.yaml
- parameters-path.yaml
- parameters.yaml
- path-parameter-validation.yaml
- petstore-expanded.yaml
- petstore-openapi-object-references.yaml
- petstore.json
- petstore.yaml
- petstore.yml
- query-parameter-validation.yaml
- readonly.yaml
- request-body-validation.yaml
- response-code-wildcard.yaml
- response-header.yaml
- self-referencing.yaml
- sinatra-array-body.yaml
- sinatra-duplicate-operation-id.yaml
- sinatra-hyphen-param.yaml
- train-travel-api
- weather_openapi.yaml
- writeonly.yaml
- x-public.yaml
- default_spec.rb
- jsonapi_spec.rb
- cookie_parameter_validation_spec.rb
- header_parameter_validation_spec.rb
- path_parameter_validation_spec.rb
- query_parameter_validation_spec.rb
- request_body_validation_spec.rb
- response_header_validation_spec.rb
- request_validation_spec.rb
- response_validation_spec.rb
- object_converter_spec.rb
- converter_spec.rb
- cookie_parameters_spec.rb
- header_parameters_spec.rb
- path_parameters_spec.rb
- x_public_spec.rb
- find_content_spec.rb
- find_response_spec.rb
- path_template_spec.rb
- hash_spec.rb
- parameter_helpers.rb
- html_reporter_spec.rb
- plan_spec.rb
- route_task_spec.rb
- callable_spec.rb
- configuration_spec.rb
- coverage_spec.rb
- methods_spec.rb
- observe_spec.rb
- dynamic-ref.yaml
- nullable.yaml
- params-with-nested-refs.yaml
- query-param-deepObject-explode.yaml
- refs-in-schema.yaml
- configuration_spec.rb
- definition_spec.rb
- example_app_spec.rb
- failure_spec.rb
- file_loader_spec.rb
- hooks_spec.rb
- openapi_first_spec.rb
- parameter_content_parsers_spec.rb
- parameter_spec.rb
- plugins_spec.rb
- query-parameter-tests.yaml
- query_string_parser_spec.rb
- ref_resolver_spec.rb
- request_body_parsers_spec.rb
- request_spec.rb
- response_parser_spec.rb
- response_validator_spec.rb
- router_spec.rb
- sinatra_spec.rb
- spec_helper.rb
- test_cases_spec.rb
- test_spec.rb
- validated_request_spec.rb
- validated_response_spec.rb
- .gitignore
- .gitmodules
- .rspec
- .rubocop.yml
- .rubocop_todo.yml
- CHANGELOG.md
- Dockerfile
- Gemfile
- Gemfile.lock
- Gemfile.multi_json
- Gemfile.rack2
- Gemfile.rack30
- Gemfile.rails6
- LICENSE.txt
- openapi_first.gemspec
- Rakefile
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/ahx/openapi_first
Downloads the entire project code from GitHub to your computer.
cd openapi_first
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t openapi-first .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 openapi-first
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Ruby
EasyPrerequisites
bundle
Type this command into your terminal and run it.
bundle exec ruby benchmarks.rb
Type this command into your terminal and run it.
If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)