我可以在Swagger中創建豐富，動態的「實現說明」嗎？

Question

我目前使用ApiOperation註釋用於記錄「實施注意事項」一節中我的Web服務的方法：

@ApiOperation(
    value = "Searches for information", 
    notes = "This service searches for information" 
) 
public Response getInformation(...) 

我想提高我的筆記現在從一個數據庫，等等。我使用屬性文件，信息希望它變得豐富而充滿活力。

所以，讓我們說我有一個包含從數據庫中信息的POJO：

@Entity 
public class SortColumnField { 
    @Id 
    @Column 
    private String fieldName; 
    @Column 
    private String fieldDescription; 
} 

有什麼可以讓我產生從對象招搖文件，如本？

Answer 1

你有兩個選擇來做這件事。

首先，筆記部分支持降價，特別是github-flavored。您可以在該部分獲得相當豐富的信息，大多數工具都可以正確顯示。

接下來，Operation Object支持稱爲externalDocs的字段。雖然未在Swagger-UI中呈現，但您可以輕鬆地分叉UI以引用可能不適合標準工具中呈現的結構的複雜文檔。