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

Vue: document api #821

Open
felixgabler opened this issue Feb 10, 2019 · 1 comment
Open

Vue: document api #821

felixgabler opened this issue Feb 10, 2019 · 1 comment

Comments

@felixgabler
Copy link
Collaborator

We can already begin documenting parts of our API.
Many endpoints around tools and jobs are already mostly finished (if they change in the future, we will just update them).
I propose a layout along these lines:
https://learning.getpostman.com/docs/postman/api_documentation/intro_to_api_documentation/

If we share the postman collection we can also use it for development purposes which would be great.

@felixgabler
Copy link
Collaborator Author

@conrizzo please take a look at https://github.com/proteinevolution/Toolkit/wiki/API-Definition-(WIP)
The way to approach this ticket would be to go over all services when running the toolkit. For each route, try to get it to fire in the browser while inspecting the network through the DevTools. Then you can easily document the query, parameters and response object structure.

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

No branches or pull requests

3 participants