API介面規範V1.0——制定好規範,才好合作開發

来源:http://www.cnblogs.com/Javame/archive/2017/09/12/7509745.html
-Advertisement-
Play Games

返回碼規範: 統一六位 000000 表示成功! 參數相關返回碼預留100000-199999;系統相關返回碼預留200000-299999;數據中心310000-319999後續項目以此類推,後續根據業務擴展情況新增操作碼需要提前備案! module = 系統碼 optCode = 操作碼 opt ...


返回碼規範:

統一六位 000000 表示成功! 參數相關返回碼預留100000-199999;系統相關返回碼預留200000-299999;數據中心310000-319999後續項目以此類推,後續根據業務擴展情況新增操作碼需要提前備案!

module = 系統碼  optCode = 操作碼  optDesc = 操作描述  resultCode = 結果碼  resultDesc = 結果描述  bizCode = 業務碼  data = 返回數據

業務碼 = 系統碼- + 操作碼- + 結果碼   業務碼內容與之前定義的保持一致,實例:TaoBao- + Order_ADD- + 330002

返回結果示例如下所示:

異常返回:

{
   "optCode": "STORE_ADDMSG",
   "optDesc": "庫管中心新增消息",
   "resultCode": "330002",
   "resultDesc": "庫管中心新增消息失敗,添加消息到搜索引擎庫異常",
   "data": "",
   "module": "HME",
   "bizCode": "TaoBao-Order_ADD-330002",
   "success": false
}

正常返回:

{
   "optCode": "STORE_ADDMSG",
   "optDesc": "庫管中心新增消息",
   "resultCode": "000000",
   "resultDesc": "操作成功",
   "data": "",
   "module": "HME",
   "success": true,
   "bizCode": "Tao-Order_ADD-000000"
}

API文檔規範:

介面名稱:
products.search

介面描述:

中醫葯產品介面調用查詢

請求參數:

響應參數:

JSON返回示例:

{
   "optCode": "STORE_ADDMSG",
   "optDesc": "數據中心新增消息",
   "resultCode": "000000",
   "resultDesc": "操作成功",
   "data": "[
            {
         "keywords": null,
         "tymc": "阿莫西林",
         "tyjx": "顆粒劑",
         "projectId": "44AFC2328D63A53EE05012AC241E3E1B",
      }]",
   "module": "HME",
   "success": true,
   "bizCode": "HME-STORE_ADDMSG-000000"
}

服務碼參照:

結果碼參照:


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 這次的學習以一個簡單的Student Demo為示例。 1、代碼: 主程式類DemoApplication.java。 1 package com.julion.demo; 2 3 import org.springframework.boot.SpringApplication; 4 import ...
  • NumPy : Numerical Python,是高性能科學計算和數據分析的基礎包。 部分功能: 大部分數據分析應用關註的功能: ...
  • 描述寫一個程式,找出給出素數範圍內的所有孿生素數的組數。一般來說,孿生素數就是指兩個素數距離為2,近的不能再近的相鄰素數。有些童鞋一看到題就開始寫程式,不仔細看題,咱們為了遏制一下讀題不認真仔細的童鞋,規定,兩個素數相鄰為1的也成為孿生素數。輸入第一行給出N(0 using namespace st... ...
  • 選擇排序是一種非常簡單的排序演算法,從字面意思我們就可以知道,選擇就是從未排序好的序列中選擇出最小(最大)的元素,然後與第 i 趟排序的第 i-1(數組中下標從 0 開始) 個位置的元素進行交換,第 i 個元素之前的序列就是已經排序好的序列。整個排序過程只需要遍歷 n-1 趟便可排好,最後一個元素自動 ...
  • PHP操作實現一個多功能購物網站 一、需要實現的頁面: Index.aspx:瀏覽商品頁面,顯示商品列表,用戶可以點擊“加入購物車“。 ViewCart.aspx:查看購物車頁面,顯示已購買的商品信息,可以點擊“刪除“和“提交添加訂單購買”商品 ViewAccount.aspx:查看個人賬戶餘額 L ...
  • 回到目錄 下麵將介紹以下幾個原則,都是軟體設計里的大哥大,大姐大級別的人物! DRY DRY是Do Not Repeat Yourself的簡稱,不要寫重覆的代碼,可以使用代碼重構里的提取到方法,提取到類來做這事 KISS KISS 是Keep it short and simple 的簡稱。意思是 ...
  • 一、引言 我們常常在會在字元串中搜索匹配字元或判斷一個字元串是否符合我們要的格式時,使用正則表達式,可解決問題的背後是一種什麼思想呢?即我們今天要學習的內容,解釋器模式 二、解釋器模式 定義:給定一個語言,定義它的文法的一種表示,並定義一個解釋器,這個解釋器使用該表示來解釋語言中的句子 1.文法:即 ...
  • 一個很簡單的淘寶優惠券搜索助手 大家看看有沒有用吧 下載地址:http://pan.baidu.com/s/1skRHTDF ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...