簡體   English   中英

Python-Flask,Swagger,從注釋生成API文檔

[英]Python-Flask,Swagger, Generate API documents from annotations

我有一個現有的書面應用程序,其中API以下列方式編寫:

@app.route('/')
def hello():
    return "Hello World":

我想從這種類型的API生成Swagger文檔。 到目前為止,我嘗試了很少的選項,但是大多數選項都是從yml文件或特定方法的docstring中的yml字符串生成文檔。

我想使用基於注釋的方法 有很少的庫可以做到這一點但他們需要為我們在代碼中沒有的每個方法都有類(並且不可能更改所有代碼)

任何人都可以給我一些指示嗎? 你在項目中使用了什么?

你試過燒瓶傻瓜嗎? 這不是你要求的,但最接近我迄今為止見過的真實事物。

當然我也更喜歡使用docstring的內容生成swagger輸入的東西。

更新:閃光燈 您將swagger doc放在裝飾瓶的文檔字符串中 - 方法和flasgger將為您的應用程序提供生成的輸出的新端點。 效果很好!

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM