Which are the tools which can be used to produce documentation for a REST API automatically using Python in Flask

Question

Hi all,

My basic requirement is as per the title. I am looking for a method to produce REST API documents automatically from a Flask REST API that I already have written previously.

I am looking to markup this code and I am looking for help with regard to starting out by asking if anyone uses any tools to achieve this purpose?

Appreciate all the help I can get, cheers!

Answer 1

Hi, good question.

There is a module meant for this exact purpose. I am sure you have heard of it, it's called Sphinx.

So what Sphinx does is that it will automatically generate documents for you as __doc__ and autodoc. Cool, right?

Did you know that even the official documentation page of Python actually used Sphinx?

Similar to the markdown text we have the reStructedText here. But it is not every time that you will prefer restructured text right?

For this exact purpose, you can use pdoc if you want to prefer Markdown text.

Hope this helps!