接口文档示例
接口文档样例模板
接口文档样例模板一、接口概述：本文档是针对XXX系统的接口文档，用于说明系统提供的各种接口的具体功能和使用方法。
二、接口列表：1.接口名称：用户登录接口请求方式：POST接口描述：用户使用用户名和密码进行登录验证，返回登录状态和用户信息。
请求参数：- username(string，必填)：用户输入的用户名。
- password(string，必填)：用户输入的密码。
返回参数：- status(string)：登录状态，值为"success"或"fail"。
- message(string)：登录状态描述信息。
- user_info(object)：用户信息，包括用户ID、昵称等。
请求示例：```json"username": "admin",}```返回示例：```json"status": "success","message": "登录成功","user_info":"user_id": 1,"nickname": "管理员"}}```2.接口名称：获取用户列表接口请求方式：GET接口描述：获取系统中所有用户的列表。
请求参数：无返回参数：- status(string)：获取状态，值为"success"或"fail"。
- message(string)：获取状态描述信息。
- user_list(array)：用户列表，包括用户ID、昵称等。
请求示例：无返回示例：```json"status": "success","message": "获取成功","user_list":"user_id": 1,"nickname": "管理员"},"user_id": 2,"nickname": "用户1"}}```三、接口调用说明：2. 接口调用前需确保用户已经获取到相应的access token，并将其作为请求头中的Authorization字段进行传递。
前后端接口文档规范模板
前后端接口文档规范模板一、概述前后端接口文档是用于规范前后端接口开发的文档，确保开发团队能够准确、快速地进行接口开发和集成。
本文档提供了一套规范模板，旨在提高开发效率、降低沟通成本，确保前后端开发能够高效协同。
二、命名规范1. 接口名称：采用英文单词或短语描述接口功能，采用驼峰命名法，首字母小写。
2. URL路径：采用全小写字母、数字和横线组合的格式，以斜杆（/）开头。
3. 请求方法：采用大写字母表示，常用的包括GET、POST、PUT、DELETE等。
4. 请求参数：采用小写字母、数字和下划线组合的格式，单词之间用下划线连接。
5. 响应状态码：采用纯数字格式表示。
三、接口说明1. 接口名称：XXX2. 接口描述：XXX3. URL路径：/xxx4. 请求方法：POST四、请求参数1. 参数名称：XXX参数类型：XXX是否必填：XXX参数说明：XXX五、响应参数1. 参数名称：XXX参数类型：XXX参数说明：XXX六、响应状态码1. 200：成功2. 400：请求参数错误3. 401：未授权4. 500：服务器错误七、示例请求示例：```json{"param1": "value1","param2": "value2"}```响应示例：```json{"code": 200,"message": "操作成功", "data": {}}```八、接口变更记录版本号：1.0修改时间：XXX修改内容：XXX九、附录详细的接口设计、规范及约束请参考附录中的相关文档。
十、总结通过使用前后端接口文档规范模板，我们可以确保接口的一致性，提高开发效率，减少沟通成本。
希望开发团队能够遵循本规范进行开发工作，确保项目的顺利进行。
以上是前后端接口文档规范模板的内容。
API接口文档(快速版)
API接口文档(快速版)概述本文档提供了关于API接口的快速参考指南，旨在帮助开发人员快速了解接口的功能和使用方法。
接口列表本文档涵盖以下API接口：... （根据实际情况继续列出其他接口）接口1：接口名称接口描述这个接口用于...请求请求类型- 请求方法：POST- 请求路径：/api/endpoint请求参数请求示例POST /api/endpoint {"param1": "value1", "param2": 123}响应响应参数响应示例{"param1": "value1", "param2": 123, ...}错误情况接口2：接口名称接口描述这个接口用于...请求请求类型- 请求方法：GET- 请求路径：/api/endpoint/{param} 请求参数请求示例GET /api/endpoint/abc123响应响应参数响应示例{"param1": "value1","param2": 123,...}错误情况接口3：接口名称接口描述这个接口用于...请求请求类型- 请求方法：PUT- 请求路径：/api/endpoint/{id} 请求参数请求示例PUT /api/endpoint/123 {"param1": "value1", ...}响应响应参数响应示例{"param1": "value1", "param2": 123,...}错误情况请根据实际情况修改接口的描述、请求参数、响应参数和错误情况等内容，并补充完整其他接口的信息。
以上仅为示例，不代表实际接口。
接口设计文档实例
接口设计文档实例接口设计文档实例：一、概述本接口设计文档描述了某电商平台的商品详情接口。
该接口提供商品详情的查询和获取功能，以便其他系统或应用能够获取商品信息。
二、接口详细说明1. 接口地址/api/v1/products/{product_id}2. 请求方法GET3. 请求参数product_id: 商品ID，必填参数。
4. 返回值说明接口返回JSON格式的数据，包含商品详情信息。
具体字段如下：id：商品ID，唯一标识符。
name：商品名称。
description：商品描述。
price：商品价格，单位为元。
stock：商品库存数量。
category：商品分类，如“电子产品”、“服装”等。
images：商品图片URL列表。
details：商品详细信息，如尺寸、颜色等。
created_at：商品创建时间，时间戳格式。
updated_at：商品更新时间，时间戳格式。
5. 异常处理如果查询不到指定ID的商品，则返回空JSON对象{}。
如果发生其他异常情况，返回错误码500和错误信息。
三、安全考虑本接口涉及到商品信息的敏感信息，需要进行身份验证和权限控制。
建议使用OAuth 等身份验证协议进行访问控制，同时对请求参数进行加密处理，保证数据传输安全。
四、性能考虑本接口需要快速响应，建议使用缓存机制来提高性能。
可以在数据库中为商品信息设置缓存，当商品信息发生更改时更新缓存。
同时，对接口进行压力测试和性能优化，确保在高并发情况下能够稳定运行。
接口文档(范例)
接口详细设计文档 (1)1 编写目的 (4)2 名词解释 (4)3组件分布图 (5)4 程序结构 (6)4.1 接入处理线程类图 (6)4.2 接收线程类图 (7)4.3 启动控制图 (7)5 程序设计说明 (8)5.1 对原系统的改动 (8)5.2 ThreadInSvcProcessor 接入处理器 (9)5.2.1 类图 (9)5.2.2 时序图 (10)5.2.3 流程图 (10)5.2.4 ThreadInSvcProcessor类说明 (12)5.3 PatternNewSyncAsyncInnerDir 同异步向内处理模式 (17)5.3.1 类图 (17)5.3.2 描述 (18)5.3.3 流程图 (18)5.3.4 类说明 (20)5.4 ThreadReplySvcProcessor 异步应答返回处理器 (25)5.4.1 类图 (25)5.4.2 类说明 (25)5.5 ClientInfo 客户端连接数据 (34)5.5.1 类图 (34)5.5.2 类描述 (34)5.6 ClientInfoTable 客户端连接数据表 (35)5.6.1 类图 (35)5.6.2 类描述 (35)5.7 ClientInfoTableMonitor 客户端连接数据表监控程序 (39)5.7.1 类图 (39)5.7.2 类说明 (39)5.8 FrontMain 主控程序 (41)5.8.1 类间关系 (41)5.8.2流程图 (42)5.8.3 类说明 (43)5.9 问题 (45)1编写目的预期读者：对接口行为和目的有一定了解的人背景说明⏹软件系统名称：接口前端接入服务器⏹描述<接口> 接收不同商家的接入，接收数据转发给主机服务器，并同步/异步将返回数据发给接入商家的行为2名词解释⏹ChannelBase 渠道,通信基类，提供数据收发和释放的方法接口用子类实现来封装了不同通信方式目前有TCP短连接接入，从ACE Message_Queue中读取（IPC MessageQueue-> ACE_Message_Queue）⏹Trade* trade 商家对象，代表的其实是针对该商家处理方法的集合将接入数据的商家称为服务商家而将请求面向的商家称为主机商家，主机商家负责同步/异步返回交易的应答数据给接口平台⏹而接口（数据交换）平台是在两者之间的交换平台⏹渠道工厂：把接入数据的渠道工厂统一定为服务渠道工厂，发送数据的渠道工厂统一定为主机通道工厂服务商家接口平台主机商家3 组件分布图ATM查不到,丢弃返回应答线程组ATM 接入服务器ATM 连接队列TCP 渠道IPC 消息队列渠道commserverIPC 消息队列注各种服务渠道和主机通道抽象类都是相同的基类ChannelBase ，只是作用不同渠道工厂生成各种渠道IPC 消息队commserver 银联 接入服务渠道抽象 代表各种接入服务渠道接出服务渠道抽象 TCP 渠道IPC 消息队列渠道发送请求线程组后台服务器连接监视器IPC 消息队列通知清除超时连接记录表接收线程 接收IPC 消总控接入主机通道抽象IPC 消息队列渠道4程序结构4.1 接入处理线程类图ThreadInSvcProcessor是接入处理线程的主流程收数，接包无误后将处理控制权交给ProcessPattern是后续处理的全部流程抽象类PatternNewSyncAsyncInnerDir是ProcessPattern的一个子类，实现发送主机服务器并判断同/异步返回同步直接返回给接入商家异步只做相应记录4.2 接收线程类图4.3 启动控制图5程序设计说明5.1 对原系统的改动⏹改变原有商家Trade类，不存放渠道对象在商家类中，商家类只执行商家处理，不负责渠道的管理⏹改动原有的系统中所有模式的处理，模式处理必须对渠道的释放负责⏹修改MidHstChannel，添加后台服务需要的２个FML字段,这两个字段是:FML域名描述S_INTERF_NO 接口标识号，整数。
接口文档范例示意
接口文档范例示意文章标题：接口文档范例示意 - 简单易懂的API文档设计与编写引言：在软件开发过程中，为了实现不同系统之间的互联互通，接口文档的编写变得尤为重要。
好的接口文档不仅能够提供清晰的指导，还能减少开发者之间的沟通成本，提高开发效率。
本文将以一个示意的接口文档范例为例，探讨如何编写一份简单易懂的API文档。
第一部分：接口概述1.1 接口名称和版本信息在接口概述中，首先需要明确接口的名称和版本信息。
例如：接口名称：用户管理接口版本号：v1.01.2 接口描述在接口描述中，应该简要说明该接口的作用和功能。
例如：该接口用于对系统中的用户进行管理，包括用户的创建、查询、更新和删除等操作。
1.3 接口区域信息和请求方式在接口区域信息和请求方式中，需要提供接口的URL区域信息以及HTTP请求的方式。
例如：接口区域信息：/api/users请求方式：GET第二部分：请求参数2.1 公共请求参数公共请求参数是指在每个接口中都需要使用的参数，例如身份认证信息、时间戳等。
在该部分中，列举出每个公共请求参数的名称、类型和是否必填。
例如：- access_token（字符串，必填）：用于身份认证的令牌。
- timestamp（字符串，必填）：请求的时间戳。
2.2 接口请求参数接口请求参数是指该接口所需的具体参数，包括请求方法（GET、POST等），请求体中的参数以及可选的路由参数等。
在该部分中，详细描述每个请求参数的名称、类型、是否必填、描述以及示例值。
例如：- name（字符串，必填）：用户姓名。
- age（整数，选填）：用户年龄。
- gender（字符串，选填）：用户性别。
示例值：'male'或'female'。
第三部分：响应参数3.1 公共响应参数公共响应参数是指在每个接口的响应结果中都会返回的参数，例如状态码、错误信息等。
在该部分中，列举出每个公共响应参数的名称、类型和描述。
接口文档示例
余额不足
101
账号关闭
102
短信内容超过500字或为空或内容编码格式不正确
103
手机号码超过200个或合法手机号码为空或者与通道不匹配
106
用户名不存在
107
密码错误
108
指定访问ip错误
109
业务不存在或者通道关闭
110
小号不合法
False
手机号或内容为空
接口名称：车托帮发送验证码接口
使用API：百悟接口
调用方式：POST
接口参数：
参数名称
参数说明
数据类型
tel_phone
el_phone
发送手机号码
Int
Verify_code
需要验证的验证码
Int
返回参数：
返回代码
代码说明
200
验证成功
501
该用户验证码不存在
502
验证失败，即验证码不正确
108
指定访问ip错误
109
业务不存在或者通道关闭
ቤተ መጻሕፍቲ ባይዱ110
小号不合法
False
手机号或内容为空或验证码存储失败
接口名称：车托帮验证验证码接口
使用API：百悟接口
参数名称
参数说明
数据类型
tel_phone
el_phone
发送手机号码
Int
接口地址：/sms.php?sms_type=2
短信服务
接口名称：短信接口
使用API：百悟接口
参数名称
参数说明
数据类型
tel_phone
el_phone
发送手机号码
Int
sms_content
接口文档范文
接口文档范文1. 引言接口文档是软件开发中非常重要的一部分，它定义了系统与外部系统或组件之间的通信接口。
本文档旨在提供一个接口文档范文，以便开发人员编写规范的接口文档，确保系统能够与其他系统或组件正确地交互。
2. 接口概述本接口文档描述了一个名为“示例系统”的接口规范。
该系统提供了一组RESTful API，用于管理用户信息。
通过这些接口，可以进行用户的创建、读取、更新和删除操作。
2.1 接口基本信息•接口名称：用户管理接口•接口版本：1.0.0•接口地址：``2.2 接口认证本接口要求进行身份认证，使用OAuth 2.0协议进行授权。
在每个请求中，需要在请求头中添加Authorization字段，其值为Bearer <access_token>，access_token需要通过授权服务器获取。
3. 接口详细说明3.1 获取用户列表•接口路径：GET /users•接口描述：获取所有用户的列表信息•请求参数：无•响应参数：–id：用户ID（整数）–name：用户姓名（字符串）–email：用户邮箱（字符串）–created_at：用户创建时间（字符串，格式为YYYY-MM-DD HH:MM:SS）•响应示例：[{"id": 1,"name": "John Doe","email":"****************","created_at": "2021-01-01 10:00:00"},{"id": 2,"name": "Jane Smith","email":"****************","created_at": "2021-01-02 11:00:00"}]3.2 获取单个用户信息•接口路径：GET /users/{id}•接口描述：根据用户ID获取单个用户的详细信息•请求参数：–id：用户ID（整数，路径参数）•响应参数：–id：用户ID（整数）–name：用户姓名（字符串）–email：用户邮箱（字符串）–created_at：用户创建时间（字符串，格式为YYYY-MM-DD HH:MM:SS）•响应示例：{"id": 1,"name": "John Doe","email":"****************","created_at": "2021-01-01 10:00:00"}3.3 创建用户•接口路径：POST /users•接口描述：创建一个新用户•请求参数：–name：用户姓名（字符串，必填）–email：用户邮箱（字符串，必填）•响应参数：–id：用户ID（整数）–name：用户姓名（字符串）–email：用户邮箱（字符串）–created_at：用户创建时间（字符串，格式为YYYY-MM-DD HH:MM:SS）•响应示例：{"id": 3,"name": "Alice Brown","email":"*****************","created_at": "2021-01-03 12:00:00"}3.4 更新用户信息•接口路径：PUT /users/{id}•接口描述：更新指定用户的信息•请求参数：–id：用户ID（整数，路径参数）–name：用户姓名（字符串，可选）–email：用户邮箱（字符串，可选）•响应参数：–id：用户ID（整数）–name：用户姓名（字符串）–email：用户邮箱（字符串）–created_at：用户创建时间（字符串，格式为YYYY-MM-DD HH:MM:SS）•响应示例：{"id": 1,"name": "John Doe","email":"********************","created_at": "2021-01-01 10:00:00"}3.5 删除用户•接口路径：DELETE /users/{id}•接口描述：删除指定用户•请求参数：–id：用户ID（整数，路径参数）•响应参数：无•响应示例：无4. 错误处理本接口遵循HTTP状态码规范进行错误处理。
【最新推荐】接口需求文档范例-范文word版 (14页)
接口文档实例
注：1、接口URL采用：域+API版本号+资源类+接口名+参数.2、以返回结果示例为准,返回结果字段说明只对部分不清晰的字段作出说明.3、因为客户端是手机,数据载体用轻便的JSON格式.一、API概览二、API说明三、API详情1.11/user/register_optional_read读取系统注册可选信息项URL//url/1/user/register_optional_read.php 支持格式JSONHTTP请求方式"result": 1,"count": 2,"content":["邮箱","年龄",...]1.21/user/read_info通过uid获取用户所有信息URL//url/1/user/read_info.php 支持格式JSONHTTP请求方式"result": 1,"uid": "001","count": 4,"user_info":{"姓名": "小王","手机号": "","邮箱": "","年龄": ""...}1.31/user/register_required_info写入注册必填信息URL//url/1/user/register_required_info.php 支持格式JSONHTTP请求方式GET"result": 1,"uid": 001,"user_name": "小王","user_phone_number": ""1.41/user/register_optional_info写入注册可选填写信息URL//url/1/user/register_optional_info.php 支持格式JSONHTTP请求方式POST"result": 1,"uid": "001","count": 4,"user_info":{"姓名": "小王","手机号": "","邮箱": "","年龄": "18"...}2.11/ppt/items读取本次会议所有要演示的PPT URL//url/1/ppt/items.php支持格式JSONHTTP请求方式GET"result": 1,"count": 2,"ppt_items":[{"ppt_id": 001,"ppt_title": "演讲一", "ppt_author": "小李","ppt_pages": 20},{"ppt_id": 002,"ppt_title": "演讲二", "ppt_author": "小刘","ppt_pages": 17},...]2.21/ppt/current_state读取当前PPT的状态URL//url/1/ppt/current_state.php 支持格式JSONHTTP请求方式"result": 1,"ppt_id": 001,"ppt_pages": 20,"ppt_pages_current": 3, "ppt_syn": 1,"ppt_full_screen": 03.11/chat/update发送一条公共信息URL//url/1/chat/update.php支持格式JSONHTTP请求方式"result": 1,"uid": 001,"mid": 001,"chat_message": "你好"//url/1/chat/private_update.php 支持格式JSONHTTP请求方式POST请求参数"result": 1,"uid": 001,"friend_id": 002,"private_mid": 001,"chat_private_message": "你好"3.31/chat/read根据mid读取未读公共信息URL//url/1/chat/read.php支持格式JSONHTTP请求方式。
接口文档范文
接口文档范文一、概述接口文档是用来描述软件系统接口的一种文档，它详细说明了系统中各个接口的功能、参数、调用方法等。
接口文档是开发人员进行开发和集成的重要参考资料，也是不同系统之间进行数据交互的重要依据。
本文将以一个示例接口文档为范本，详细介绍接口文档的内容和编写要求。
二、接口名称接口名称：用户注册接口三、接口描述该接口用于用户注册功能，用户可以通过该接口完成账号的注册。
四、接口地址接口地址：/api/register五、请求方法POST六、请求参数参数名类型是否必填描述username string 是用户名，长度为6-20个字符password string 是密码，长度为6-20个字符email string 是邮箱地址七、请求示例{"username": "testuser","password": "123456", "email":"****************"}八、返回参数参数名类型描述code int 返回码，0表示成功，-1表示失败message string 返回消息九、返回示例{"code": 0,"message": "注册成功"}十、错误码错误码描述-1 注册失败1001 用户名已存在1002 邮箱已被注册十一、接口备注无十二、接口变更记录版本号修改时间修改内容1.0 2021-01-01 初始版本1.1 2021-02-01 增加返回参数code和message结论接口文档是软件开发过程中必不可少的一部分，它起到了明确各个接口的功能和使用方法的作用。
本文以一个用户注册接口为例，详细介绍了接口文档的内容和编写要求。
在实际编写接口文档时，需要确保内容准确严谨，避免歧义或错误信息的出现。
同时，良好的结构和清晰的语言描述也是编写接口文档的重要要求。
(完整版)接口文档样例模板.doc
项目名称
项目信息（接口模块名称）
功能描述：
【获取项目基本信息（整个项目信息模块的接口功能描述）】
返回说明：（统一的接口返回方式）
参数名称类型描述
Code String 状态码：
200 成功
404 错误Msg String 信息描述Data 返回的数据
1.获取项目基本信息（/v1/project/get）
【对标题接口必须有序号，方便后期的维护和修改跟进】【接口功能描述】
1.1 、请求协议（https）
1.2 、请求方式（
1.3 、输入参数：
字段中文名
项目 ID GET）
英文名类型是否必填业务补充描述Project_id bigint Y
1.4 、返回信息：
字段中文名英文名类型业务补充描述项目 ID Id
楼盘 Code f_house_code
项目名prj_name
标签prj_tags
开发商developers
销售状态project_sale
经纬度project_location
project_sale 返回信息
字段中文名英文名类型业务补充描述
销售状态sale_status 在售、待售、售
完
project_location
字段中文名英文名类型业务补充描述
经度longitude
纬度latitude
1.5 、业务返回规则要求（业务方面的返回要求，比如查询结果按照时间排序之类的）
1、查询结果按照创建时间排序显示。
接口规范文档
接口规范文档一、接口概述。
接口规范文档主要用于定义系统之间的接口交互规范，包括接口的功能描述、参数说明、返回结果、错误码定义等内容。
接口规范文档的编写是为了确保系统之间的数据交换和通信能够顺利进行，同时也方便开发人员进行接口的调用和开发。
二、接口定义。
1. 接口名称，getUserInfo。
2. 接口描述，用于获取用户信息。
3. 请求方式，GET。
4. 请求URL，/api/user/info。
5. 请求参数：参数名类型是否必须描述。
userId int 是用户ID。
6. 返回结果：{。
"code": 200,。
"message": "success",。
"data": {。
"userId": 123,。
"username": "张三",。
"age": 25,。
"gender": "male",。
"email":"********************" }。
}。
7. 错误码定义：错误码描述。
400 参数错误。
401 用户未登录。
403 没有权限。
500 服务器内部错误。
三、接口调用示例。
1. 请求示例：GET /api/user/info?userId=123。
2. 返回结果：{。
"code": 200,。
"message": "success",。
"data": {。
"userId": 123,。
"username": "张三",。
"age": 25,。
"gender": "male",。
接口文档说明示例
支付网关说明文档by:Q294500001目录##联盟支付网关说明文档........................................................................ 错误!未定义书签。
目录 .. (1)第一章文档描述.............................................................................................. 错误!未定义书签。
1、文档说明 (1)2、阅读对象 (1)第二章系统原理 (2)1、术语定义 (2)2、消费流程 (2)3、查询流程 (2)4、系统加密 (2)第三章网银接口定义 (3)1、同步过程接口定义（商户系统发起请求） (3)2、下行异步通知过程接口定义（##联盟接口发起请求） (5)3、下行同步通知过程接口定义（##联盟接口发起请求） (7)第四章查询流程接口定义 (8)第五章订单外部查询独立网址...................................................................... 错误!未定义书签。
附录1：##联盟支付网关银行类型说明. (9)第一章文档描述1、文档说明本说明文档用于指导##联盟商户实现与##联盟网银接口的顺利对接。
请相关技术人员详细阅读本文档。
2、阅读对象商户开发人员。
第二章系统原理1、术语定义商户：指已独立拥有在线销售系统，并成为##联盟网银接口系统会员，且已使用或者将使用##联盟网银接口实现收付费或其他相关功能需求的企业或者个人。
外部接入接口：指##联盟通过统一的方式接受外部请求的接口。
商户系统：指使用##联盟外部接入接口的计算机系统，一般指商户所拥有的在线销售系统。
用户：指在商户系统内进行消费的企业或者个人。
商户ID：指##联盟为使用外部接入接口的商户统一分配的唯一标识。
后台接口文档示例
后台接⼝⽂档⽰例什么是接⼝⽂档？在项⽬期间，前后端是分离开发的，为了前后有连贯性，就必须由前后开发⼯程师共同定义接⼝、写接⼝⽂档再根据接⼝⽂档去开发，⼀直到项⽬结束。
接⼝⽂档规范⽅法 也就是我们常写的新增，删除，修改，查询url 调⽤⽅法，⼀般是从前端调后端的⽅法地址请求参数 ⼀般分五列：字段、说明、类型、备注、是否必填返回参数 1、如果只返回接⼝调⽤成功还是失败（新增、删除、修改等），则只有⼀个结构体： code和message两个参数； 2、如果要返回某些参数，则有两个结构体： 是code/mesage/data； 是data⾥写返回的参数,data是object类型； 3、如果要返回列表，那么有三个结构体， 是code/mesage/data,data是object，⾥⾯放置page/size/total/totalPage/list 5个参数，其中list是Arrary类型，list⾥放object，object⾥是具体的参数。
了解⽬的1. ⽤户登录2. ⽤户注册3. 树形菜单4. ⽂章查询5. ⽂章新增6. ⽂章修改7. ⽂章删除⽤户登录： 接⼝调⽤and请求http请求⽅式: POST （⼀般有两种get/post）https://xxx.xxx.xxx:8080/项⽬命名/vue/userAction_login.action字段说明类型是否必填uname名字String是pwd密码String是登录成功返回JSON数据包:{"msg":"登录成功","result":{"uname":"⽤户名","pwd":"密码"},"code":1}⽤户或者密码为空返回JSON数据包:{"msg":"⽤户或者密码为空","result":{"uname":"⽤户名","pwd":"密码"},"code":0}⽤户或者密码错误返回JSON数据包:{"msg":"⽤户或者密码错误","result":{"uname":"⽤户名","pwd":"密码"},"code":0}参数说明msg提⽰消息result返回登录的⽤户名和密码code状态 0：登录失败 1：登录成功⽤户注册 接⼝调⽤https://xxx.xxx.xxx:8080/项⽬命名/vue/userAction_reg.action字段说明类型是否必填uname名字String是pwd密码String是注册返回JSON数据包：{"msg":"⽤户注册成功","code":1}⽤户注册失败返回JSON数据包：{"msg":"⽤户注册失败","code":0}参数说明msg提⽰消息code状态码 0：失败 1：成功树形菜单调⽤接⼝https://xxx.xxx.xxx:8080/项⽬命名/vue/treeNodeAction.action返回的json数据表如下：{"msg": "操作成功","result": [{"treeNodeId": 1,"treeNodeName": "系统管理","treeNodeType": 1,"url": null,"position": 1,"icon": "el-icon-setting","children": [{"treeNodeId": 2,"treeNodeName": "⽤户管理","treeNodeType": 2,"url": "/sys/VuexPage1","position": 2,"icon": "el-icon-user","children": []},{"treeNodeId": 3,"treeNodeName": "⾓⾊管理","treeNodeType": 2,"url": "/sys/VuexPage2","position": 3,"icon": "","children": []},{"treeNodeId": 4,"treeNodeName": "密码修改","treeNodeType": 2,"url": null,"position": 4,"icon": null,"children": []}]},{"treeNodeId": 5,"treeNodeName": "论坛管理","treeNodeType": 1,"url": null,"position": 5,"icon": "el-icon-reading","children": [{"treeNodeId": 6,"treeNodeName": "⽂章管理","treeNodeType": 2,"url": "/sys/Articles","position": 6,"icon": null,"children": []}]}],"code": 1}参数说明msg提⽰消息result返回树形菜单结果集code状态 0：失败 1：成功Result树形菜单结果集参数说明treeNodeId菜单idtreeNodeName菜单名treeNodeType菜单类型 1：⽗菜单2：跳转菜单url路由地址icon菜单图标children⼦菜单集，如果没有则为⼀个空json数组⽂章查询调⽤接⼝https://xxx.xxx.xxx:8080/项⽬命名/vue/articleAction_list.action参数是否必填说明page否当前页码，默认为1page否当前页码，默认为1rows否⼀页展⽰多少条数据，默认为10title否按⽂章标题查询返回json数据包说明：{"result":[{"id":1,"title":"⽂章标题","body":"⽂章内容"],"pageBean":{"page":1,"rows":10,"total":100,}}result结果集参数说明id⽂章idtitle⽂章标题body⽂章内容pageBean 分页对象说明参数说明page当前页码rows⼀页展⽰的条数total总条数⽂章添加调⽤接⼝https://xxx.xxx.xxx:8080/项⽬命名/vue/articleAction_add.action参数是否必填说明title是⽂章标题Body否⽂章内容添加成功返回JSON数据包：{"msg":"新增成功","result":[],"code":1}添加失败返回JSON数据包：{"msg":"新增失败","result":[],"code":0}参数说明msg提⽰消息code状态码 0：失败 1：成功⽂章修改调⽤接⼝https://xxx.xxx.xxx:8080/项⽬命名/vue/articleAction_edit.action参数是否必须说明id是⽂章idtitle否⽂章标题body否⽂章内容修改成功返回JSON数据包：{"msg":"修改成功","code":1}修改失败返回JSON数据包：{"msg":"修改失败","code":0}参数说明msg提⽰消息code状态码 0：失败 1：成功⽂章删除调⽤接⼝https://xxx.xxx.xxx:8080/项⽬命名/vue/articleAction_del.action参数是否必须说明id是⽂章id删除成功返回JSON数据包：{"msg":"删除成功","code":1}删除失败返回JSON数据包：{"msg":"删除失败","code":0}参数说明msg提⽰消息code状态码 0：失败 1：成功谢谢观看！。
接口文档示例DRF
接⼝⽂档⽰例DRF **简要描述：**- 企业信息统计接⼝**请求URL：**- ` http://127.0.0.1/ztx_data/v1/ep_info `**请求⽅式：**- GET**参数：**|参数名|必选|类型|说明||:---- |:---|:----- |----- ||username |是 |string |⽤户名 ||password |是 |string | 密码 |**返回⽰例**``` json// 成功响应// 分页数据{"code": 200,"msg": "success","errors": {},"data": {"count": 28,"next": "http://127.0.0.1:8000/process_drf/?page=2&size=5","previous": null,"results": [{"id": 13,"code": "process_13","name": "企业门户","remark": "","sign": "0","rto": null,"rpo": null,"state": "9","sort": 4,"url": "/falconstor","type": "falconstor","color": "#e7505a"},{"id": 14,"code": "2","name": "mkl","remark": "hehehehe","sign": "0","rto": 1,"rpo": 2,"state": "9","sort": 5,"url": "/falconstor","type": "falconstor","color": "#32c5d2"},]}}// 单条记录{"code": 200,"msg": "success","errors": {},"data": {"id": 15,"code": "asd","name": "sadad","remark": "hahaha","sign": "0","rto": 2,"rpo": 3,"state": "1","sort": 6,"url": "/falconstor","type": "falconstor",}}// POST{"code": 201,"msg": "success","errors": {},"data": {"id": 42,"code": "s","name": "a","remark": null,"sign": null,"rto": null,"rpo": null,"state": null,"sort": null,"url": "","type": null,"color": ""}}// PUT{"code": 200,"msg": "success","errors": {},"data": {"id": 15,"code": "asd","name": "mkl","remark": "hahaha","sign": "0","rto": 2,"rpo": 3,"state": "1","sort": 6,"url": "/falconstor","type": "falconstor","color": "#8e44ad"}}// DELETE{"code": 200,"msg": "success","errors": {},"data": {}}```**返回参数说明**|参数名|类型|说明||:----- |:-----|----- ||groupid |int |⽤户组id，1：超级管理员；2：普通⽤户 | **备注**- 返回企业信息| 错误码 | 错误解释 || ------------ | ------------ || 401 | ⽤户认证失败 || 403 | 权限校验失败 || 422 | ⼊参错误 |- 返回⽰例> POST请求```json{"code": 422,"msg": "⼊参错误","errors": {"code": "This field may not be blank.","name": "This field may not be blank."},"data": {}}```> GET请求```json"code": 422,"msg": "error","errors": {"param": "Process matching query does not exist."},"data": {}}项⽬⽰例：# @file :views.py# @description :企业信息应⽤视图# @date :2021/07/01 18:02:52# @author :miaokela# @version :1.0from rest_framework.generics import GenericAPIViewfrom django.http import Http404from company import extra_modelsfrom ZTXDMS.utils.response import APIResponsefrom ZTXDMS.utils.pagination import RestPaginationfrom company.serializers import (CompanyListSerializer,CompanyDetailSerializer,AgencyListSerializer,AgencyDetailSerializer,)from company.conf import sqlsclass CompanyAPIView(GenericAPIView):queryset = extra_ing('company').exclude(is_delete='1').order_by('-update_time') serializer_class = CompanyListSerializerpagination_class = RestPaginationdef get(self, request):queryset = self.get_queryset()if request.query_params:company_name = request.query_params.get('company_name', '').strip()queryset = queryset.filter(company_name__contains=company_name)# TODO 数据库没有的数据从企查查站点采集page = self.paginate_queryset(queryset)if page is not None:serializer = self.get_serializer(page, many=True)return self.get_paginated_response(serializer.data)ser = self.get_serializer(page, many=True)return APIResponse(code=200, data=ser.data)class CompanyDetailAPIView(GenericAPIView):queryset = extra_ing('company').exclude(is_delete='1').order_by('-update_time') lookup_field = 'id'def delete(self, request, id):try:qcc = self.get_object()qcc.is_delete = '1'qcc.save()except Exception as e:print('error:{0}'.format(e))return APIResponse(code=404, msg='failed', errors={'id': ['记录不存在，删除失败。
开发接口文档API文档实用模板
版本控制信息版本日期描述作者2018-8-13 创办XXX1获取所有字段1.1 获取所有字段央求地址： /session/field/findAll央求参数参数名必填字段种类描述name是String依照名称精选响应code10000 成功， -1 系统错误， 10001 必填参数为空message响应描述result如响应例子央求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统办理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconCo lour":"","iconSize":0,"iconStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5 ,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0}2文件上传2.1 文件上传（ ajax ）央求地址： /session/file/upload央求参数参数名必填字段种类描述file是FormData FormData 对象包含的文件响应code10000 成功， -1 系统错误， 10001 必填参数为空message响应描述result如响应例子央求例子： var formData = new FormData();("file", [0]);$.ajax({url : routePath + "/session/file/upload",type : 'POST',data : formData,processData : false,contentType : false,success : function(result) {result = (result);if == "10000"){(' 上传成功！ ');$("#editHeadPortrait").val } }});响应例子： returnValue里包含了fileName和filePath3字段管理 - 所属种类3.1 新增所属种类央求地址： /session/fieldType/save央求参数参数名必填字段种类描述name是String所属种类名称响应code10000 成功， -1 系统错误， 10001 必填参数为空message响应描述result如响应例子央求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统办理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}3.2 更正所属种类央求地址： /session/fieldType/update央求参数参数名必填字段种类描述id是Long所属种类idname是String所属种类名称响应code10000 成功， -1 系统错误， 10001 必填参数为空message响应描述result如响应例子央求例子： &name=test响应例子： {"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统办理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}3.3 依照 id 获取所属种类央求地址： /session/fieldType/getById央求参数参数名必填字段种类描述id是Long所属种类id响应code10000 成功， -1 系统错误， 10001 必填参数为空message响应描述result如响应例子央求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统办理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":{"id":2,"name":"re"},"totals":0}3.4 获取所属种类列表央求地址： /session/fieldType/selectAll央求参数参数名必填字段种类描述name否String依照种类名称精选响应code10000 成功， -1 系统错误， 10001 必填参数为空message响应描述result如响应例子央求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统办理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":[{"id":1,"name":"123"},{"id":6,"name":"145555"}],"totals":2}3.5 删除所属种类（批量）央求地址： /session/fieldType/deleteByIds央求参数参数名必填字段种类描述ids是List所属种类id 会集响应code10000 成功， -1 系统错误， 10001 必填参数为空message响应描述result如响应例子央求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统办理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}。