api数据接口文档_接口文档示例(Taobao/jd/pinduoduo/开放接口调用)

news/2024/4/23 19:56:40/

api数据接口文档_接口文档示例

 本文主要是提供了一个接口文档的范文,内容修订历史、目录、时序图、接口要素描述、接口说明、使用示例、字典、FAQ。
 使用MD格式文档(makedown),选择原因,容易格式转换,开发便于修改,版本维护界面,修改记录明显,普通文本工具即可编辑。

下方是接口文档的示例:

参数说明

  • 通用参数说明
    • 参数不要乱传,否则不管成功失败都会扣费
    • url说明 https://api-gw.onebound.cn/平台/API类型/ 平台:淘宝,京东等, API类型:[item_search,item_get,item_search_shop等]
    • version:API版本
    • key:调用key,测试key:test_api_key(点*击*注*册*免*调*用)
    • secret:调用secret,测试secret:(不用填写)
    • cache:[yes,no]默认yes,将调用缓存的数据,速度比较快
    • result_type:[json,xml,serialize,var_export]返回数据格式,默认为json
    • lang:[cn,en,ru] 翻译语言,默认cn简体中文
    • secret:密钥
  • API:item_search 参数说明:

    • q:搜索关键字
    • cat:分类ID
    • start_price:开始价格
    • end_price:结束价格
    • sort:排序[bid,bid,bid2,_bid2,_sale,_credit]
      (bid:总价,bid2:商品价格,sale:销量,credit信用,加
      前缀为从大到小排序)
    • page:页数
    • page_size:每页宝贝数量,默认40
    • seller_info:是否获取商家信息[yes,no],默认yes
  • API:item_get 参数说明: num_iid:宝贝ID

**API说明**

## 修订历史

| 日期       | 内容                                                         | 版本     | 作者   |
 | ———- | ———————————————————— | ——– | —— |
 | 2021/09/10 | 初稿                      | Ver. 1.0 | NHK|
 

 ## 目录 

[TOC]

## 文档介绍
   本文档用于XXX业务的接口说明和使用说明。
 

### 功能时序图

“`sequence
 API-> APISERVER: 系统连接
 APISERVER -> API: 连接成功
 API -> APISERVER: 系统登录
 APISERVER –> API: 登录成功
 API -> APISERVER: 业务请求
 APISERVER –> API: 业务响应
 API -> APISERVER: ……
 APISERVER –> API: ……
 API –> APISERVER: 系统连接断开
 APISERVER -> API: 系统连接断开响应
 “`

## 接口要素描述

### 术语定义

– **JAVAGW:**系统的网关,有路由、广播等功能。
 – **JAVAAPI:**JAVA语言所调用的程序,提供JAVA语言的API接口。直接连接JAVAGW。
 – **APISERVER:**对外提供JSON格式接口,连接JAVAGW。
 – **C++API :**为C++语言提供的程序,连接APISERVER。
 – **PythonAPI:**为PythonAPI语言提供的程序,连接APISERVER。
 – **C#API :**为C#语言提供的程序,连接APISERVER。

### 语法描述

#### 基础语法

       接口使用JSON格式传输,语法规则遵循JSON语法规则。

#### **描述语法**
 – **【0..0】:**表示无需赋值。
 – **【0..1】:**表示可以有0个或1个实例。
 – **【1..1】:**表示只能有一个实例。
 – **【1..*】:**表示至少有一个实例。
 – **【0..*】:**表示对实例的数目没有限制。
 – **【X.Y】:**表示X集合内的Y属性。示例:参数【orderList.exchId】,orderlist中exhcId的参数,订单集合中市场属性。
 – **【X^】:**表示X的集合中,有一个参数必送。示例:参数A ,参数标识【X^】 参数B ,参数标识【X^】 ,参数A、B必送一个。

### 数据类型

int:整数类型

long:长整型

double:浮点类型

String:字符串

list:代表数组或集合

## 接口清单

### 功能列表

| 接口  | 名称               | 接口支持 |
 | —– | —————— | ——– |
 | 100000 | 功能1                         |[✔]JAVA[✔]python|
 

#### 100000 -功能1

##### 接口定义

##### 注意事项

##### 参数说明

请求参数

| **参数**                                       | 中文名称                                       | **类型** | 长度  | 参数标识 | 示例值 |
 | ———————————————- | ———————————————- | ——– | —– | ——– | —— |
 | **value**                                     | 值1                                       | String   | 1     | 【1..1】 |        |
 | **ValueList**                      | 值对象列表                                     | list     | 999   | 【0..*】 |        |
 | **【ValueList.value1】**            | 值对象1                                     | String   | 35    | 【0..*】 |        |
 | **ValueList1**                      | 值列表1                                     | list     | 999   | 【0..*】 |        |

响应参数

| **参数**                                   | 中文名称     | **类型** | 长度 | 参数标识 | 示例值 |
 | —————————————— | ———— | ——– | —- | ——– | —— |
 | [**successFlg**](#successFlg-成功失败标识) | 成功失败标志 | int      | 1    | 【1..1】 | 0      |
 | **errorCode**                              | 错误代码     | String   | 8    | 【0..1】 |        |
 | **failInfo**                               | 错误信息     | String   | 200  | 【0..1】 |        |
 | **value**                            | 存取值1号   | string   | 24   | 【1..*】 |        |

##### DEMO范例

###### JAVAAPI

com.xxx..api.Interface.func(Funcvalue value)

“`java
 …..
 
 “`

## 使用示例(业务场景)

### XXX业务使用用例说明

#### 变更说明

#### XXX示例

## 数据字典

### successFlg-成功失败标识

|字典代码|名称|描述|
 |——|————–|——–|
 |0|成功||
 |1|失败||
 

## FAQ


http://www.ppmy.cn/news/47516.html

相关文章

LeetCode238. 除自身以外数组的乘积

238. 除自身以外数组的乘积 描述示例解题思路解法1(最最暴力求解,但不符合要求)解法2(暴力求解,也不符合要求,但时间复杂度O(N))解法3(最优解,符合题意,时间复杂度O(N)) 描述 给你一个整数数组 nums&#…

Linux的.serivice文件介绍

一、什么是.service文件? linux中.servic文件是服务的配置文件,通过systemctl进行操作。存放位置:/usr/lib/systemd/system 二、配置说明 通常在,service配置文件中包含三个部分,分别为: 一、[Unit]:控制部…

创造rap一首,关于毕业论文难写,导师不负责

Verse1: 毕业季节,任务繁重 毕业论文,压力倍增 想着论文顺利,却被教授推脱 努力攀登高峰,却是一场空 Chorus: 毕业论文难写,导师不负责 对论文监督,一筹莫展 毕业论文难写,难缠之处 摆脱麻烦&am…

Unity记录3.5-地图-第三阶段总结

文章首发及后续更新:https://mwhls.top/4493.html,无图/无目录/格式错误/更多相关请至首发页查看。 新的更新内容请到mwhls.top查看。 欢迎提出任何疑问及批评,非常感谢! 汇总:Unity 记录 摘要:柏林噪声与 …

Linux -- 进阶 Web服务器 基础前瞻( 二 )

WWW服务器的类型 : 静态网站 官方 : 仅提供用户浏览的单向静态网页,单纯是由服务器单向提供数据给客户端,Server 不 需要与client 端有互动,可以浏览网站,但是无法数据上传。 ( 说白就是 服务器提供的…

C++并发锁相关并发

互斥锁mutex #include <mutex> {std::mutex mtx;mtx.lock();// do somethingmtx.unlock(); } mutex成员方法&#xff1a;lock()、try_lock()、unlock() try_lock&#xff1a; 1&#xff09;所有线程都没有lock时&#xff0c;调用lock&#xff0c;并返回true&#xff1b;…

鉴智机器人重磅发布双目智驾解决方案,新一代全系智驾产品线亮相上海车展

4月18日&#xff0c;以「拥抱汽车行业新时代」为主题的2023上海车展正式拉开帷幕。以视觉3D理解为核心的下一代自动驾驶系统提供商鉴智机器人&#xff0c;携全新升级的智驾产品线首次亮相车展&#xff0c;重磅发布基于AI的双目立体视觉智驾方案。 凭借双目立体视觉系统的差异化…

Event Camera (事件相机)

1.传统相机的缺点 1.随着计算机视觉领域的不断发展&#xff0c;目标检测的算法也越来越多样化&#xff0c;特别是近些年深度学习在计算机视觉领域的进步&#xff0c;已经产生了很多优秀的目标检测方法&#xff0c;这些基于帧的方法对于图片的质量有一定的要求&#xff0c;比如合…

电感耦合等离子体原子发射光谱法(ICP-AES)

一、定义 电感耦合等离子体原子发射光谱法(ICP-AES)&#xff0c;是以电感耦合等离子矩为激发光源的光谱分析方法&#xff0c;具有准确度高和精密度高、检出限低、测定快速、线性范围宽、可同时测定多种元素等优点&#xff0c;国外已广泛用于环境样品及岩石、矿物、金属等样品中…

【学习笔记】Integral Human Pose Regression

【学习资料】一文总结Integral Pose Regression方法的方方面面 - 知乎&#xff08;总结的很到位&#xff0c;一定要去看&#xff09; 1.两种基本方法的对比 1.解码方式 softmax和argmax的区别&#xff1a; 由于深度神经网络中的下采样步骤&#xff0c;热图的分辨率低于输入…

4.15搞力扣哈哈

1. 1023. 驼峰式匹配 难度中等107收藏分享切换为英文接收动态反馈 如果我们可以将小写字母插入模式串 pattern 得到待查询项 query&#xff0c;那么待查询项与给定模式串匹配。&#xff08;我们可以在任何位置插入每个字符&#xff0c;也可以插入 0 个字符。&#xff09; 给…

边缘计算那些事儿—边缘智能技术

0 背景 边缘智能是边缘计算中一个非常重要的方向。它将边缘计算和人工智能算法结合起来&#xff0c;在边缘设备上就近处理目标检测、物体跟踪&#xff0c;识别等任务。这种处理方式可以降低时延&#xff0c;减少数据上送云端对回传网络的冲击&#xff0c;同时保证数据的隐私和安…

linux安装和使用jekins

Jenkins详细安装配置部署--超详细_jenkins安装部署_宝贝富贵猪的博客-CSDN博客 1.安装JDK 2.获取安装包 下载页面&#xff1a;https://jenkins.io/zh/download/ 或者Index of /jenkins/redhat/ | 清华大学开源软件镜像站 | Tsinghua Open Source Mirror 3.安装Jenkins sud…

持续集成部署 - Docker-compose 部署 Redis 集群(三主三从)

Docker-compose 部署 Redis 集群 1. 拉取 Redis 镜像2. 在任意目录下创建一个名为“docker-compose.yml”的文件。3. 在终端中导航到项目根目录并运行以下命令:4. 初始化集群5. 测试Redis集群环境本次部署使用 Redis 版本为:6.2.0,为单机 Redis 集群,为什么是单机的,因为 …

python爬虫原理及源码解析(入门)

目录 一、爬虫是什么&#xff1f;二、爬虫的基本原理三、HTTP协议与响应4、爬虫实现源码 一、爬虫是什么&#xff1f; ​ 如果将互联网比作一张大的蜘蛛网&#xff0c;数据便是存放在蜘蛛网的各个节点&#xff0c;而爬虫就是一只小蜘蛛&#xff0c;沿着网络抓取自己的猎物(数据…

开启虚拟机出现报错:“此主机支持 Intel VT-x,但 Intel VT-x 处于禁用状态”

&#x1f341;博主简介 &#x1f3c5;云计算领域优质创作者   &#x1f3c5;华为云开发者社区专家博主   &#x1f3c5;阿里云开发者社区专家博主 &#x1f48a;交流社区&#xff1a;运维交流社区 欢迎大家的加入&#xff01; 文章目录 报错原因解决方式&#xff08;这里以…

Dart进阶

Dart 是一种用于构建应用程序的编程语言&#xff0c;它具有许多语法糖&#xff08;Syntactic Sugar&#xff09;特性&#xff0c;这些特性能够简化代码并提高开发效率。以下是 Dart 中一些常见的语法糖特性&#xff1a; 级联操作符&#xff08;Cascade Notation&#xff09;&a…

无限制翻译软件-中英互译字数无限

翻译软件是我们工作及学习中必不可少的工具&#xff0c;然而许多翻译软件在使用时常常会出现字数限制的问题,这使得用户在处理长文本和大量文本时变得十分麻烦。如果你也遇到了类似的问题&#xff0c;那么哪个翻译软件不限制字数将为您带来全新的翻译体验。 以下是我们的哪个翻…

2023年4月18面试题目分享(笔试+面试)

武汉某上市公司的面试分享 一、笔试题目 1.“”和”equals“方法的区别&#xff1f; 2.是否可以从一个static方法内部发出对非static方法的调用以及为什么&#xff1f; 3.Integer和int的区别&#xff1f; 4.重载和重写的区别&#xff1f; 5.C中构造器Constructor是否可以被ov…

Windows10的Ubuntu上搭建Python3.11的wxPython4开发环境

第一步&#xff0c;现在windows10上安装Ubuntu 20.04.5 LTS&#xff1b; 第二步&#xff0c;下载Python3.11.2的源代码&#xff0c;然后编译安装&#xff1b; 第三步&#xff0c;下载pip安装工具&#xff1b; 第四步&#xff0c;安装wxPython pip3 install -U wxPython 结…