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

Detailed documentation for API + Service Clients #107

Open
pmohankumar opened this issue Apr 25, 2017 · 0 comments
Open

Detailed documentation for API + Service Clients #107

pmohankumar opened this issue Apr 25, 2017 · 0 comments
Assignees

Comments

@pmohankumar
Copy link
Contributor

As of today, big challenge for consumers of Poseidon before they ripe the benefits is lack of detailed documentation on "how-to-do" stuff.

Though we improved upon wiki on arch, design principles etc behind poseidon as well as we've a sample app to get started, we lack documentation around actual implementation details like (not comprehensive list)

  1. How to make some query parameters optionals in API
  2. Does poseidon support optional path parameters
  3. How to avoid a hydra failure while returning an optional response
  4. How to do file upload, download
  5. How to pass multi value headers to service clients
  6. How to talk to a HTTPS service from poseidon service client
  7. How to map exceptions to a http response globally
  8. How to add global and api-local filters
    ...

Some of these have been shared as gist to consumers outside flipkart (like HealthFace.in)
https://gist.github.com/pmohankumar/aa173878e0abf65edd0ec9f9a4509f20
https://gist.github.com/pmohankumar/282d41444a9510a8f94d13f79ed375a4
https://gist.github.com/pmohankumar/6f51f4a15be9f693ed702185e3099315
https://gist.github.com/pmohankumar/e5013adea0a7279a2231861f33f915c4
https://gist.github.com/pmohankumar/1e86f88b6845d074415f27ac9a183136

But we need to improve upon the documentation soon!

@shrey-garg , can you get someone to work on this once the sale fever subsidies.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants