I'm documenting my opinion of the rest api

I do not understand how the documentation is supposed to look like I
would like an example if some one has already done this before.