API discovery should be customizable

cognitect-labs / vase

Data driven microservices

Eclipse Public License 1.0

373 stars 42 forks source link

API discovery should be customizable #74

Closed deg closed 5 years ago

deg commented 7 years ago

Currently Vase exposes simple API discovery (cognitect.vase.routes/describe-api) as an endpoint at the root of each API tree.

This should be configurable, presumably via an option to the API definition in the service .edn file since:

On the one extreme, I might not want to reveal my entire API.
On the other extreme, I might want to offer a much richer discovery mechanism. At the very least, I can see often wanting to return the information as a navigable data structure, rather than a flat string.

ohpauleez commented 7 years ago

Thanks for voicing your interest!

In an upcoming version of Vase, we are introducing more control over various aspects of the descriptor itself.

But keep in mind, Vase is only generating routes and interceptor chains -- you can already take full control over the construction of those routes. For example, you might consider post-processing the route sequence generated by vase/routes -- removing/replacing/short-circuiting the route browser endpoint.

deg commented 7 years ago

Thanks. Your workaround is easy enough, and solves my problem now.

I appreciate that you will be adding more control in an upcoming version. If adding control of discovery is already in your roadmap, then I'm 100% good here. Thanks!

ddeaguiar commented 5 years ago

This is related to #91. The url should be configurable as well.

ddeaguiar commented 5 years ago

Closing as per this comment on #91.