Question

I’m looking for a quick way to auto produce REST API docs from a Flask REST API I’ve written. Does anyone know of tools that can do this and how I would markup the code?

Answer 1

I would recommend you Sphinx, you add your documentation as __doc__ and the autodoc module of Sphinx will generate the docs for you (docs.python.org also uses Sphinx). The markup is reStructuredText, similiar to Markdown (if you prefer Markdown, you can use pdoc).

e.g.:

@app.route('/download/<int:id>')
def download_id(id):
    '''This downloads a certain image specified by *id*'''
    return ...