softwaremill / softwaremill/tapir

Improve user experience for defining gRPC endpoints

Open
#2,449 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Currently, to add a new grpc method we need to specify the path under which it should be available (service/method) and pass it as the endpoint path to the endpoint definition. We should be able to make it more user-friendly.

The whole flow of defining new methods should be revisited and reconsidered.

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

The issue names the gRPC endpoint-definition flow but no files, tests, or entry points. Start by locating how service/method paths are currently passed into endpoint definitions, then document the desired defining experience and verify the revised flow with appropriate gRPC endpoint coverage.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
api, backend-api-design
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.