DEV Community

Discussion on: Documenting your API with API Blueprint

Collapse
 
albertofdzm profile image
Alberto Fernandez Medina

Thanks for the comment!

I think that documentation is needed always to ensure the health of the project, sometimes even more than tests. In my actual company, we were documenting at least the necessary things and we are losing it day by day.

The main problem, in my opinion, is that sometimes nobody reads these docs for months until someone new comes to the team or you have to reuse some of that features, and probably by then that info would be obsolete.

I agree with you that is hard to maintain documentation.

In my next article, I'll be using Dredd for test these docs against the API server ensuring by that way the info is up to date. So, at the end, this docs will be more useful ensuring even code coverage.