本文主要是提供了一個接口文檔的范文，內(nèi)容修訂歷史、目錄、時序圖、接口要素描述、接口說明、使用示例、字典、FAQ。
使用MD格式文檔（makedown），選擇原因，容易格式轉換，開發(fā)便于修改，版本維護界面，修改記錄明顯，普通文本工具即可編輯。

下方是接口文檔的示例：

**API說明**

## 修訂歷史

| 日期 | 內(nèi)容 | 版本 | 作者 |
| ———- | ———————————————————— | ——– | —— |
| 2021/09/10 | 初稿 | Ver. 1.0 | NHK|

## 目錄

[TOC]

## 文檔介紹
本文檔用于XXX業(yè)務的接口說明和使用說明。

### 功能時序圖

“`sequence
API-> APISERVER: 系統(tǒng)連接
APISERVER -> API: 連接成功
API -> APISERVER: 系統(tǒng)登錄
APISERVER –> API: 登錄成功
API -> APISERVER: 業(yè)務請求
APISERVER –> API: 業(yè)務響應
API -> APISERVER: ……
APISERVER –> API: ……
API –> APISERVER: 系統(tǒng)連接斷開
APISERVER -> API: 系統(tǒng)連接斷開響應
“`

## 接口要素描述

### 術語定義

– **JAVAGW：**系統(tǒng)的網(wǎng)關，有路由、廣播等功能。
– **JAVAAPI：**JAVA語言所調(diào)用的程序，提供JAVA語言的API接口。直接連接JAVAGW。
– **APISERVER：**對外提供JSON格式接口，連接JAVAGW。
– **C++API ：**為C++語言提供的程序，連接APISERVER。
– **PythonAPI：**為PythonAPI語言提供的程序，連接APISERVER。
– **C#API ：**為C#語言提供的程序，連接APISERVER。

### 語法描述

#### 基礎語法

? 接口使用JSON格式傳輸，語法規(guī)則遵循JSON語法規(guī)則。

#### **描述語法**
– **【0..0】：**表示無需賦值。
– **【0..1】：**表示可以有0個或1個實例。
– **【1..1】：**表示只能有一個實例。
– **【1..*】：**表示至少有一個實例。
– **【0..*】：**表示對實例的數(shù)目沒有限制。
– **【X.Y】：**表示X集合內(nèi)的Y屬性。示例：參數(shù)【orderList.exchId】，orderlist中exhcId的參數(shù)，訂單集合中市場屬性。
– **【X^】：**表示X的集合中，有一個參數(shù)必送。示例：參數(shù)A ，參數(shù)標識【X^】 參數(shù)B ，參數(shù)標識【X^】 ，參數(shù)A、B必送一個。

### 數(shù)據(jù)類型

int：整數(shù)類型

long：長整型

double:浮點類型

String：字符串

list:代表數(shù)組或集合

## 接口清單

### 功能列表

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

#### 100000 -功能1

##### 接口定義

##### 注意事項

##### 參數(shù)說明

請求參數(shù)

| **參數(shù)** | 中文名稱 | **類型** | 長度 | 參數(shù)標識 | 示例值 |
| ———————————————- | ———————————————- | ——– | —– | ——– | —— |
| **value** | 值1 | String | 1 | 【1..1】 | |
| **ValueList** | 值對象列表 | list | 999 | 【0..*】 | |
| **【ValueList.value1】** | 值對象1 | String | 35 | 【0..*】 | |
| **ValueList1** | 值列表1 | list | 999 | 【0..*】 | |

響應參數(shù)

| **參數(shù)** | 中文名稱 | **類型** | 長度 | 參數(shù)標識 | 示例值 |
| —————————————— | ———— | ——– | —- | ——– | —— |
| [**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
…..

“`

## 使用示例（業(yè)務場景）

### XXX業(yè)務使用用例說明

#### 變更說明

#### XXX示例

## 數(shù)據(jù)字典

### successFlg-成功失敗標識

|字典代碼|名稱|描述|
|——|————–|——–|
|0|成功||
|1|失敗||

## FAQ

總結

以上是生活随笔為你收集整理的api数据接口文档_接口文档示例(读懂API接口文档)的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。