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

0 votes
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!
Jan 14 in Python by Anirudh
• 2,070 points

1 answer to this question.

0 votes

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!

answered Jan 14 by Nymeria
• 3,520 points

Related Questions In Python

0 votes
1 answer

Which IDE can be used for Python on Mac OS X

Have tried many different (Kate, Eclipse, Scite, ...READ MORE

answered Oct 15, 2018 in Python by SDeb
• 13,160 points
0 votes
1 answer
0 votes
1 answer

How can I lookup hostname using the IP address with a timeout in Python?

Good question. I actually was stuck with ...READ MORE

answered Feb 6 in Python by Nymeria
• 3,520 points
0 votes
3 answers

Python Selenium best tutorials for beginners

Hope this will help you...Python Tutorial READ MORE

answered Feb 11 in Python by aldrinjohn
• 140 points
0 votes
1 answer

How to output the rows which are affected using SQLAlchemy in Python?

Hi, good question. This is actually not ...READ MORE

answered Feb 15 in Python by Nymeria
• 3,520 points