-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
Document HTTP endpoints in query and collector services #158
Comments
|
Do you have any preference for the framework? What is the most used/mature one in Go? I found this https://github.com/go-swagger/go-swagger |
When you say framework, it implies not just documenting but refactoring the endpoints to use that framework so that documentation and code are in sync. I'd agree swagger is the way to go. However, we first need to investigate how it will work with graphql, because we certainly need graphql to streamline interactions with UI. I don't know if graphql frameworks also help with auto documenting the API. |
Related discussion https://groups.google.com/forum/#!topic/jaeger-tracing/L27aTD9kXRc |
Duplicate of #456 |
We don't really define our API anywhere, and we should do so. This is probably a good issue to bring up the idea of using swagger for self-documentation.
The text was updated successfully, but these errors were encountered: