Coder Social home page Coder Social logo

Improve api consistency about tapir HOT 3 CLOSED

softwaremill avatar softwaremill commented on July 17, 2024
Improve api consistency

from tapir.

Comments (3)

adamw avatar adamw commented on July 17, 2024 1

I feared that too many of these combinators might be confusing :) But first, some motivation on why there are two ways to group parameters in the first place. I want to support two scenarios:

  1. creating a description of (possibly multiple) input (output) parameters which can be re-used in many endpoint descriptions. For example, quite often you have paging & limit parameters grouped in listing APIs. You can represent this as: val paging = query[String]("start") and query[Int]("limit") and use it in many endpoints

  2. creating re-useable endpoint descriptions, which can be specialized. For example, in your API all endpoints might have a path which starts with /api and upon error, return a ErrorInfo JSON. You can represent this as: val baseEndpoint = endpoint.in("api").errorOut(jsonBody[ErrorInfo]) and use it as a base endpoint for all other endpoints.

Given the tradeoff between less ways to group parameters and supporting the two use-cases above, I pick the second option.

However, we might still simplify the usages of and, / and &. Maybe it would make sense to drop &, and define / only for paths, that is on PathCapture and PathSegment, not on all EndpointIOs?

from tapir.

adamw avatar adamw commented on July 17, 2024

In the end keeping and and / as ways to combine inputs is as much as I could get - essentially dropping &. Any other suggestions welcome :)

from tapir.

adamw avatar adamw commented on July 17, 2024

Closing as "won't fix" for the reasons above. Feel free to reopen if you've got new ideas :)

from tapir.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.