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.

Sign up for GitHub

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

Jump to bottom

Add API documentation #17

Open

Spenhouet opened this issue Jan 15, 2023 · 0 comments

Labels

documentation enhancement

Collaborator

Spenhouet commented Jan 15, 2023 •

edited

Loading

Currently the API is not documented and its availability is not visible. Go with a slate docs design as done in spenhouet.com/beautiful-docs and tailwindui.com/templates/protocol. Similar to the language switcher, show a response result switcher (200, 404). As good examples take a look at CoinMarketCap API Documentation and the Stripe API Documentation. If possible, make the query parameters changeable and dynamically load the new query results like done by Open API as in the example of DefiLlama.

Spenhouet added the enhancement label

Spenhouet added this to the Q1 2023 milestone

Spenhouet added this to bcked roadmap

Spenhouet added the documentation label

Spenhouet modified the milestones: Q1 2023, Q2 2023

Spenhouet modified the milestones: Q2 2023, Q4 2023

Spenhouet removed this from the Q4 2023 milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment