API接口规范V1.0——制定好规范,才好合作开发

返回码规范:

统一六位 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"
}

服务码参照:

结果码参照:

时间: 2024-10-11 08:48:39

API接口规范V1.0——制定好规范,才好合作开发的相关文章

Linux系统部署规范v1.0

Linux系统部署规范v1.0 目的: 1.尽可能减少线上操作: 2.尽可能实现自动化部署: 3.尽可能减少安装服务和启动的服务: 4.尽可能使用安全协议提供服务: 5.尽可能让业务系统单一: 6.尽可能监控可监控的一切信息: 7.尽可能控制一切可控制的安全策略: 8.尽可能定期更新补丁修补漏洞: 具体规范: A. 帐户和口令 帐户: 1.为每个系统维护人员建立一个独立的普通权限帐号,为监控机建立监控帐号,分别用于日常系统维护和系统监控: 2.FTP 服务器配置虚拟帐号: 3.禁止除root 帐

Android编程规范V1.0

转载请注明出处:http://blog.csdn.net/zhaokaiqiang1992 本文章是根据众多公司的编程规范整理而成,如果错误,还请指出. Android编程规范 编写人 赵凯强 日期 2014-8-5 审核人   日期   批准人   日期     修改记录(REVISION CHART) 版本 作者 修改描述 修改日期 1.0 赵凯强 初稿 2014-8-5     1.概述 1.1目的与概述 本文提供一整套编写高效可靠的android代码的标准.约定和指南.它们以安全可靠的软

安卓开发开发规范手册V1.0

安卓开发开发规范手册V1.0 之前发布过一份Web安全开发规范手册V1.0,看到收藏文章的读者挺多,发现整理这些文档还挺有意义. 最近周末抽了些时间把之前收集关于安卓安全开发的资料也整理了一下,整理出一份安卓安全开发手册,大部分内容都是在一些博客看到各位师傅的分享. 一.manifest文件安全 1.1 禁止PermissionGroup的属性为空 PermissionGroup可以对permission进行一个逻辑上的分组.如果PermissionGroup的属性为空,会导致权限定义无效,且其

API接口规范

协议 API与用户的通信协议,总是使用HTTPs协议,确保交互数据的传输安全. 域名 应该尽量将API部署在专用域名之下.       https://api.example.com 如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下.       https://example.org/api/ api版本控制 应该将API的版本号放入URL.      https://api.example.com/v{n}/    另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便

API 接口规范

整体规范建议采用RESTful 方式来实施. 协议 API与用户的通信协议,总是使用HTTPs协议,确保交互数据的传输安全. 域名 应该尽量将API部署在专用域名之下. https://api.example.com 如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下. https://example.org/api/ api版本控制 应该将API的版本号放入URL. https://api.example.com/v{n}/ 另一种做法是,将版本号放在HTTP头信息中,但不如放入UR

ColKang v1.0

最近尝试写一下NFA到DFA转换的函数,用C++,但是想到集合的表示比较麻烦,一些高级的容器也还没学到,因此自己先写一个简单的collection类,1.0版本. 能实现的功能有:存储数字集合:能进行集合间比较O(N)及加O(M+N)减法O(N):能向集合中添加元素O(N)或删除元素O(N):能返回集合中第X小的元素O(1) 因为目前对C++理解较为有限,特别是写一个类的时候感到力不从心,因此很多地方应该都不是很符合规范,先将这个能实现基本功能的代码贴上来,再想一下以后的改进空间,之后写出更加完

部署Bookinfo示例程序详细过程和步骤(基于Kubernetes集群+Istio v1.0)

部署Bookinfo示例程序详细过程和步骤(基于Kubernetes集群+Istio v1.0) 部署Bookinfo示例程序 在下载的Istio安装包的samples目录中包含了示例应用程序. Bookinfo应用 部署一个样例应用,它由四个单独的微服务构成,用来演示多种 Istio 特性.这个应用模仿在线书店的一个分类,显示一本书的信息.页面上会显示一本书的描述,书籍的细节(ISBN.页数等),以及关于这本书的一些评论. Bookinfo 应用分为四个单独的微服务: productpage

MathExam小学一二年级计算题生成器V1.0

MathExam小学一二年级计算题生成器v1.0 一.预估与实际 PSP2.1 Personal Software Process Stages 预估耗时(分钟) 实际耗时(分钟) Planning 计划 ? Estimate ? 估计这个任务需要多少时间 880 1540 Development 开发 ? Analysis ? 需求分析 (包括学习新技术) 60 100 ? Design Spec ? 生成设计文档 20 20 ? Design Review ? 设计复审 10 20 ? Co

平安科技智能投顾接口设计说明书_陆基金 v1.0.5

平安科技 智能投顾项目 RBPAA接口设计说明书(for 陆基金) 第1.0.4版 平安科技(深圳)有限公司创新品牌体验团队智能投顾组 二○一七年十月 版本控制信息 版本 日期 拟稿和修改 作者 说明1.0 2018-4-25 初稿 陈培镇 ?目录1 概述 12 接口约定 13 接口列表 14 接口组成 15 接口描述 25.1 基金领域 25.1.1 基金盘中实时估值接口(F100) 25.1.2 基金最新估值查询接口(F101) 35.1.3 基金基础信息查询接口(F102) 35.1.4