介面開發規範

一、介面的定義

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 {
//站點id
private string siteid;
//頁面id
private string pageid;
//頁面名稱
private string pagename;
//別名
private string pagealiase;
//模版id
private string templateid;

定義介面

在 api介面工程專門定義介面，在api工程單獨定義介面的原因如下：

1、介面集中管理

2、api工程的介面將作為各微服務遠端呼叫使用。

頁面查詢介面定義如下：

public inte***ce cmspagecontrollerapi {

public queryresponseresult findlist(int page, int size, querypagerequest querypagerequest) ;

二、為了嚴格按照介面進行開發，提高效率，對請求及相應格式進行規範化。三、api定義約束

api 定義使用springmvc來完成，由於此介面後期將作為微服務遠端呼叫使用，在定義介面時有如下限制：

1、@pathvariable 統一指定引數名稱，如：@pathvariable(「id」)

2、@requestparam統一指定引數名稱，如：@requestparam（「id」）

介面開發規範

為了嚴格按照介面進行開發，提高效率，對請求及響應格式進行規範化。get 請求時，採用key value格式請求，springmvc可採用基本型別的變數接收，也可以採用物件接收。響應結果統一資訊為 是否成功 操作 提示資訊及自定義資料。響應結果統一格式為json。api定義使用springmvc來完成...

WEB介面開發規範

web 介面開發規範 1 每個功能頁面在系統中配置選單時統一使用 index.jsp 或index.html 例如客戶管理配置的 url為 2 每個頁面的 title 必須設定為和選單配置中相同的中文，例如在選單項中配置為 客戶管理 則此頁面的 title 也要設定為 客戶管理 3 對於jsp 頁面...

API 介面開發規範

api與使用者的通訊協議，總是使用https協議，確保互動資料的傳輸安全。應該盡量將api部署在專用網域名稱之下。如果確定api很簡單，不會有進一步擴充套件，可以考慮放在主網域名稱下。應該將api的版本號放入url。v 另一種做法是，將版本號放在http頭資訊中，但不如放入url方便和直觀。gith...