Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proxy route endpoint swagger #1181

Closed
grahamehorner opened this issue Aug 13, 2021 · 4 comments
Closed

Proxy route endpoint swagger #1181

grahamehorner opened this issue Aug 13, 2021 · 4 comments
Labels
Type: Idea This issue is a high-level idea for discussion.

Comments

@grahamehorner
Copy link

The reserve proxy should be able to aggregate swagger documents from multiple endpoints/routes and present them with/without its swagger document so api are discoverable with minimal effort and api clients can be generated using standard tooling.

@grahamehorner grahamehorner added the Type: Idea This issue is a high-level idea for discussion. label Aug 13, 2021
@samsp-msft
Copy link
Contributor

I would suggest that the ability to morph swagger documents goes against the separation of concerns principal of software design. The core of the proxy is the ability to efficiently marshal requests, translating swagger is something that, by comparison, would be infrequently used, and therefore probably doesn't belong in the proxy.
That being said, it would be an interesting tool to have to be able to manipulate swagger documents based on the url mapping of a proxy, but I would suggest its probably more of a command line thing, rather then being built into the core of the proxy.

@amweiss
Copy link
Contributor

amweiss commented Aug 16, 2021

This seems similar to my request of #1107 to have a way to view the endpoints at runtime, and in this case the upstream swagger docs themselves as well. This may be possible via some extension work where you define/lookup the swagger dock of the destination so it can be provided to the URLs parameter of something like Swashbuckle.

https://github.com/domaindrivendev/Swashbuckle.AspNetCore#list-multiple-swagger-documents

@samsp-msft
Copy link
Contributor

Duplicate of #1107

@samsp-msft samsp-msft marked this as a duplicate of #1107 Aug 19, 2021
@samsp-msft
Copy link
Contributor

The overall problem of fetching route info at runtime via an API is covered by #124. #1107 is the extension to project that into swagger.

Not a feature for YARP 1.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Idea This issue is a high-level idea for discussion.
Projects
None yet
Development

No branches or pull requests

3 participants