1. 程式人生 > >spring介面文件註解:@ApiOperation

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風格的介面功能。