What is the best format for writing API documentation?

Question

Upwork

Good afternoon!
We wrote the API documentation, the question arose of how clear the documentation is. Help deal with this issue. Here is the documentation https://2polyglot.com/api/ . What is the best format for writing API documentation?

Answer 1

The main page of the passport + registration page is enough.
If you really want to from the bank, then the bank makes statements, ask for one where the first sheet has your home address, the name of the bank and, of course, a bank seal with bank details.

Answer 2

Everything is beautiful, good, but you need a search at least by the names of the functions.
And categories, there everything is broken up by blocks, but there is one level in the menu.
The categories are collapsed by default to make it very quick to find the feature you need, even without searching.
Well, why do the documentation in Russian at all :)
There are more English words there, choose one thing. And then it goes through the line Russian / English: dsro.ru/gyazo/images/69aedddce842039de0fa83223b12.png

Answer 3

I strongly advise you to pay attention to raml.org
from this case, the documentation for the API is very well and beautifully generated