What is the correct way to write REST API documentation?

Question

Yii

The question is how to write documentation for a mobile application.
This is my first time making REST API on YII2.
I started writing documentation in Google Doc, but it's not very convenient.
What solutions are there so that it would be possible for IOS or ANDROID developers to write documentation.
Thank you.

Answer 1

Where to write documentation, in Google Docs, Markdown directly in the repository or something else - it doesn’t matter, the main thing is that you feel comfortable.
It is important that this documentation be as complete and accurate as possible.
Alternatively, you can look at raml if you want a specialized format.

Answer 2

I really like https://apiary.io/

Answer 3

Markdown is usually a convenient option - a simple syntax for writing manually, you can edit it directly from the IDE, it's convenient to read on the same GitHub, it won't get lost if you put it along with the source code.

Answer 4

I would look towards RAML as suggested by Yuri Shikanov , as well as mulesoft 's anypoint service which uses RAML and provides a console and designer.