Skip to content

Documenting Python REST API whining


A downside of Python dynamic nature is that REST API documentation won’t generate right out of your code, like Swagger does for Java.
The best you can get is http://pythonhosted.org/sphinxcontrib-httpdomain/, for which you need to duplicate all of your REST service method signatures in ReStructured text, a format I’m not a fan of.
One can get a pretty-formatted Twitter-Bootstrap-enabled doc for Eve REST framework. But I’m not using Eve, and one has to duplicate service methods API in a Cerberus schema description.

Post a Comment

Your email is never published nor shared.