softwaremill / softwaremill/tapir

Provide a generator that can generate valid requests/responses from an Endpoint definition

Open
#4,124 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
1.5k
Forks
468
Avg merge
5h 37m
Merged PRs (30d)
34

Description

Following this conversation:
It would be very helpful to have a tool that can generate requests & responses from an Endpoint definition.

Motivation:
There are many ways we can use such a tool.
In the scenario I describe in the original conversation,
I speak of using such ability with e.g. scalacheck's Gen to create valid requests/responses.
Those can then be tested against a given OpenAPI schema with tools like: swagger-request-validator.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Endpoint definition and the linked discussion to determine the intended generator scope. Investigate how ScalaCheck's Gen could consume endpoint information and how generated requests and responses would be checked with swagger-request-validator. Done means the project has a defined, usable way to generate valid requests and responses from an Endpoint.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
api, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.