klein icon indicating copy to clipboard operation
klein copied to clipboard

Support for URL endpoint documentation (eg. swagger/openapi)

Open NirmalVatsyayan opened this issue 8 years ago • 3 comments

Hi , I need a help. Is there any way to get url end point documentation, in django and flask we could use swagger for the same. Kindly suggest the best possible way to represent apis on UI similar to that, if there is any.

Regards

NirmalVatsyayan avatar Nov 24 '16 05:11 NirmalVatsyayan

There are no swagger/openapi plugins for klein as of this moment, but it wouldn't be too difficult to create one on your own ;) this is a subtle hint that you should make something for the rest of the klein/twisted world to use. I recently made merge request showing how to extend klein #146. Using that example as a reference, it should be possible to create a swagger schema and generate a swagger page. If you need basic endpoint documentation, Sphinx is very good at creating a simple non-interactive doc.

On a final note, try to ask these kinds of questions on the Twisted section of Stackoverflow in the future.

notoriousno avatar Nov 25 '16 17:11 notoriousno

Turning this into a feature request

wsanchez avatar Dec 09 '16 19:12 wsanchez

Would be great to have this feature!

FastAPI and others have it; and it's pretty handy.

SamuelMarks avatar Oct 31 '23 18:10 SamuelMarks