search

phalcon / rest-api

Implementation of an API application using the Phalcon Framework
https://phalcon.io
MIT License
89 stars 34 forks source link

Documentation #16

Open docteuri opened 6 years ago

docteuri commented 6 years ago

Hello,

I would like to help on the auto-documentation part.

Do you have in mind a composer class you would prefer to use ?

It could be phalcon-swagger or swagger-php for API and ApiGen for docs.

Thanks a lot for this lib

niden commented 6 years ago

Hello @docteuri

For the documentation, since this is an example application and has limited endpoints I was planning on creating markdown files explaining each endpoint in detail and then showing it on screen using a volt file/view.

I will give Swagger a try to see if it can help us.