Comments (3)
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:
-
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 -
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 aErrorInfo
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 EndpointIO
s?
from tapir.
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.
Closing as "won't fix" for the reasons above. Feel free to reopen if you've got new ideas :)
from tapir.
Related Issues (20)
- Netty gRPC server HOT 1
- [BUG] Option of CommaSeparated has a strange behavior when no value is provided HOT 6
- [BUG] "type mismatch" when attempting to compile endpoint test (Tapir + Zio2 + Http4s + Circe + Doobie) HOT 3
- [BUG] Enumeration schema is inconsistent depending on the encoding function HOT 3
- [BUG] Invalid AsyncAPI documentation generated. HOT 3
- Implement multipart body support in sttp stub
- Snake case and discriminator config ignored HOT 5
- [BUG] route won't match if `extractFromRequest` is followed by a static path or path parameter input HOT 1
- Validate discriminator values HOT 8
- Simple default bundle compatible with Scala toolkit HOT 7
- [BUG] semiauto schema derivation looses generic type HOT 1
- [BUG] mapping is sometimes lost in schema generation
- Should we prevent space inside endpoint name/operationId HOT 1
- How to handle an error with fs2.Stream based endpoint HOT 2
- Release latest tapir with `sttpApispec` set to `0.11.0` HOT 1
- [BUG] Routing Regression in 1.10.13(ZIO-HTTP) HOT 8
- `SttpClientInterpreter` does not propagate headers in the http response for websockets HOT 6
- Compile crash when deriving case classes using OpenAI Schema annotations HOT 2
- Schema Magnolia Derivation inlines a null that breaks Scala 3's -Yexplicit-nulls compiler option HOT 1
- Strange behaviour of HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from tapir.