spring介面文檔註解：@ApiOperation

標籤：title   添加   api文檔   spingmvc   好用   swagger   api   關注   size   

spring介面文檔註解：@ApiOperation

@ApiOperation不是spring內建的註解是swagger裡的 
com.wordnik.swagger.annotations.ApiOperation;

@ApiOperation和@ApiParam為添加的API相關註解，個參數說明如下： 
@ApiOperation(value = “介面說明”, httpMethod = “介面請求方式”, response = “介面返回參數類型”, notes = “介面發布說明”；其他參數可參考源碼； 
@ApiParam(required = “是否必須參數”, name = “參數名稱”, value = “參數具體描述”

實際項目中非常需要寫文檔，提高Java服務端和Web前端以及移動端的對接效率。

Swagger是當前最好用的Restful API文檔產生的開源項目，通過swagger-spring項目

實現了與SpingMVC架構的無縫整合功能，方便產生spring restful風格的介面文檔，

同時swagger-ui還可以測試spring restful風格的介面功能。

spring介面文檔註解：@ApiOperation（轉）