search

TiagoGouvea / open-source-event-management

0 stars 0 forks source link

API documentation #6

Open TiagoGouvea opened 8 years ago

TiagoGouvea commented 8 years ago

We can use some tool for help us to write the API documentation.

http://swagger.io/ https://apiary.io/

Swagger have some PHP parsers, who read all the code looking for annotations and then build the DOCS. https://github.com/zircote/swagger-php

By this way we could have the documentation without hard work.

What you think?

abdala commented 8 years ago

Swagger seems good

TiagoGouvea commented 8 years ago

Another one is http://apidocjs.com/

But, looking better, it take the methods annotation soooooo long.

mrprompt commented 8 years ago

I vote for Swagger too