Answer the question
In order to leave comments, you need to log in
How to arrange api access to data, so that it would be comfortable to work with it?
Good time of the day!
There is a library of http/https and wss/ws requests (on node.js)
I make open access to data for my service.
Access is only for receiving data, i.e. on get requests.
What is the best way to arrange them for an external user?
I have a few things in my head:
1) Make a library on js, it already collects all the methods to get the necessary data, like the slack library for example . And the same is the same for php, python, go, java (unfortunately it didn’t work in other languages)
2) There is an example of well-formed documentation, and is it possible to upload it automatically somehow, only swagger comes to mind, but I have a way to design it I don't like it so much, can anyone suggest a better one?
3) I took Rest for the architectural approach, I understand this is a holistic question, but the question is, if I switch to graphql, can I automatically document it, like in swagger?
And the last question - does anyone have examples?
What service has the nicest API you've ever worked with?
Answer the question
In order to leave comments, you need to log in
what's wrong with a swagger?
otherwise, arrange documentation generation based on comments in the code, and you will always have up-to-date documentation. Unless, of course, you are an adherent of self-documented code.
Why do you need graphql? Do you have cool analytics and need complex sections?
About the access code. Write on what you can, and most importantly, add examples on pure http, for example, as in Yandex, where the call to any api is described precisely through curl requests
Didn't find what you were looking for?
Ask your questionAsk a Question
731 491 924 answers to any question