[發明專利]一種接口定義方法和數據傳輸方法及裝置

有效

• 申請號: 201410247048.2
• 申請日: 2014-06-05
• 公開（公告）號: CN105335310B
• 公開（公告）日: 2020-05-08
• 發明（設計）人: 徐凱;王躍樂;董松潔
• 申請（專利權）人: 阿里巴巴集團控股有限公司
• 主分類號: G06F13/38
• 分類號: G06F13/38
• 代理公司: 北京晉德允升知識產權代理有限公司 11623
• 代理人: 楊移

本申請公開了一種接口定義方法和數據傳輸方法及裝置，用以解決現有技術中定義接口的準確性和可擴展性較低的問題。該方法接口工具采用預設的接口描述語言定義接口，根據定義的接口生成接口文件，將接口文件提供給服務端，使服務端根據接口文件中包含的原始格式中各字段與目標格式中各字段的對應關系，將原始格式的數據轉換為目標格式的數據。由于本申請采用預設的接口描述語言定義接口，而接口描述語言對字段的描述能力較強，可準確的描述目標格式中的各字段，因此可有效提高定義接口的準確性。另外，由于接口描述語言除了可描述基于HTTP的接口以外，還可描述基于其他協議的接口，因此也可有效提高定義接口的可擴展性。

技術領域

本申請涉及計算機技術領域，尤其涉及一種接口定義方法和數據傳輸方法及裝置。

背景技術

隨著計算機技術的發展，由后端設備向前端設備提供數據、由前端設備根據該數據為用戶提供服務的模式已經非常普遍。其中，后端設備可以是服務端，前端設備可以是客戶端。

例如，客戶端可先向服務端發送諸如超文本傳輸協議(Hyper Text TransferProtocol，HTTP)請求等請求消息，服務端接收到該請求消息后，則根據該請求消息向客戶端返回相應的數據，客戶端則解析接收到的數據并展現給用戶。

但是，如果客戶端能夠解析的數據的格式與服務端返回的數據的格式不一致，就會導致客戶端不能正確的解析服務端返回的數據，因此，這就需要預先定義客戶端和服務端之間的接口，使服務端返回的數據的格式能夠被客戶端正確的解析。

具體的，在現有技術中，一般使用api-blueprint工具來定義接口。由于api-blueprint工具定義接口所使用的是markdown語言，因此，對于用戶來說，使用api-blueprint工具定義的接口具有較好的可讀性。

然而，雖然markdown語言對用戶具有較強的可讀性，但其對具體字段的描述能力不足，如，markdown語言不能描述一個字段中的數據是整型還是浮點型，也不能描述數據的取值范圍等，這就導致使用markdown語言定義接口的準確性較低。而且，markdown語言只能描述基于HTTP的接口，不能對基于其他協議的接口進行描述，這也導致使用markdown語言定義接口的可擴展性較低。

發明內容

本申請實施例提供一種接口定義方法和數據傳輸方法及裝置，用以解決現有技術中定義接口的準確性和可擴展性較低的問題。

本申請實施例提供的一種接口定義方法，包括：

接口工具采用預設的接口描述語言定義接口；

根據定義的所述接口生成接口文件，其中，所述接口文件中包含原始格式中各字段與目標格式中各字段的對應關系；

將所述接口文件提供給服務端，使所述服務端根據所述接口文件將原始格式的數據轉換為目標格式的數據。

本申請實施例提供的一種數據傳輸方法，包括：

服務端接收請求消息；

根據所述請求消息確定要返回的原始格式的數據；

根據接口工具提供的接口文件中包含的原始格式中各字段與目標格式中各字段的對應關系，將所述原始格式的數據轉換為目標格式的數據；

返回轉換的目標格式的數據。

本申請實施例提供的一種接口定義裝置，包括：

定義模塊，用于采用預設的接口描述語言定義接口；

接口文件生成模塊，用于根據定義的所述接口生成接口文件，其中，所述接口文件中包含原始格式中各字段與目標格式中各字段的對應關系；