The source code as a documentation is fine if you're the only one who is using the API. But when you open up to third-party, the absence of a good documentation will render your API useless to others. Since jk/restserver manage its functionality via DocBlock comments it's straight forward to generate a comprehensive documentation from it.
I have something like http://swagger.io/ in mind. But other languages are already worth to consider.
Implement one or more of the following API specification/description languages:
The source code as a documentation is fine if you're the only one who is using the API. But when you open up to third-party, the absence of a good documentation will render your API useless to others. Since
jk/restservermanage its functionality via DocBlock comments it's straight forward to generate a comprehensive documentation from it.I have something like http://swagger.io/ in mind. But other languages are already worth to consider.
Implement one or more of the following API specification/description languages: