一、接口的定義
1.1 定義請求模型QueryPageRequest，此模型作為查詢條件類型。為后期擴展需求，請求類型統一繼承RequestData類型。

package com.xuecheng.framework.domain.cms.request; import com.xuecheng.framework.model.request.RequestData; import lombok.Data; @Data public class QueryPageRequest extends RequestData {//站點idprivate String siteId;//頁面IDprivate String pageId;//頁面名稱private String pageName;//別名private String pageAliase;//模版idprivate String templateId;

1.2 響應結果類型，分頁查詢統一使用QueryResponseResult

定義接口
在 Api接口工程專門定義接口，在Api工程單獨定義接口的原因如下：
1、接口集中管理
2、Api工程的接口將作為各微服務遠程調用使用。
頁面查詢接口定義如下：

public interface CmsPageControllerApi {public QueryResponseResult findList(int page, int size, QueryPageRequest queryPageRequest) ;

此接口編寫后會在CMS服務工程編寫Controller類實現此接口。

二、為了嚴格按照接口進行開發，提高效率，對請求及相應格式進行規范化。
1.get 請求時，采用key/value格式請求，SpringMVC可采用基本類型的變量接收，也可以采用對象接收。
2.Post請求時，可以提交form表單數據（application/x-www-form-urlencoded）和Json數據（Content-
Type=application/json），文件等多部件類型（multipart/form-data）三種數據格式，SpringMVC接收Json數據使用@RequestBody注解解析請求的json數據。
3.響應結果統一信息為：是否成功、操作代碼、提示信息及自定義數據。
4.響應結果統一格式為json。

三、Api定義約束
Api 定義使用SpringMVC來完成，由于此接口后期將作為微服務遠程調用使用，在定義接口時有如下限制：
1、@PathVariable 統一指定參數名稱，如：@PathVariable(“id”)
2、@RequestParam統一指定參數名稱，如：@RequestParam（“id”）

總結

以上是生活随笔為你收集整理的接口开发规范的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。