REST Documentation genarator


(Kebyang1511) #1

Good day Yii community… I would like to solicite some feedbacks from you guys about your experience in REST documentation generators…

I would like to know what made you choose it and which one do you prefer ?

I am currently working on a REST backend and will soon release documentation for our clients. Im wondering if what documentation generator would be best to use with Yii

Thank you in advance Yii community…


(Alexander Makarov) #2

In order to use generator you need to describe a schema. If you haven’t and do not plan to, the best way is just to describe it using markdown.


(Andrzej Bernat) #3

And keep the schema up to date in the future along with the endpoints.


(Alexander Makarov) #4

It’s usually the other way around:

  1. Change description.

  2. Show it to the guys doing clients and get approval.

  3. Change code to work like described.