接口文档样例模板

合集下载

接口文档样例模板

接口文档样例模板一、接口概述：本文档是针对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字段进行传递。

app接口文档模板

XXX项目APP接口文档首页 (3)首页 (3)加载更多商品 (7)用户注册 (9)注册 (9)发送手机验证码 (11)用户中心 (12)登录 (12)登出 (14)原产品 (15)产品列表 (15)产品详情 (18)分类树 (22)备注： (23)注：传参一律用post方式，key=request, value为一串json格式字符串，格式如：request={"head": {"partner": "xxxxxxxxxxxxxxxxxxxxxxx","key": "xxxxxxxxx","mdkey": "xxxxxxxxxxx"},"para": {"user_name": "user_name","pwd": "123456"},"result": {"start": 0,"count": 10}}head：头信息，用于安全校验，参数固定为partner、key、mdkey 三项，mdkey随不同接口而变，partner和key为常量头部信息校验错误统一返回，错误码分三种：1：PARTNER有误{"head": {"code": "C0004","msg": "PARTNER验证失败！"}}2：KEY有误{"head": {"code": "C0005","msg": "KEY验证失败！"}}3：MD5加密错误{"head": {"code": "C0001","msg": "请求验证失败！"}}para：请求体，客户端请求所需要传入的参数，依据不同接口而定result：结果集，主要用于分页首页首页URL：输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(partner+key)},"result": {"start": 0, //从第0条数据开始，（首页此项参数只能为0）"count": 20 //总共返回20条数据，（即每页显示数量，由客户端自定）}}输入参数说明：错误码：参考头部信息校验统一错误码正确返回：{"head": {"code": "10000","msg": "数据获取成功"},"para": {"banner": [{"ad_id": "2","ad_name": "首页轮转2","pic": "/data/files/mall/ad/1434512150.jpg","link": "/index.php?app=search&act=products&cid=1312","image_size": {"width": 1200,"height": 475}},{"ad_id": "3","ad_name": "首页轮转3","pic": "/data/files/mall/ad/1434523823.png","link": "/joinus/","image_size": {"width": 1200,"height": 475}}……],"cate": [{"cate_id": "1216","cate_name": "女装","cate_ename": "WOMEN","cate_banner": "/data/files/mall/category/2015/06/201506100640272205.jpg","image_size": {"width": 460,"height": 300}},{"cate_id": "1217","cate_name": "男装","cate_ename": "MEN","cate_banner": "/data/files/mall/category/2015/06/201506081359262711.jpg","image_size": {"width": 460,"height": 300}}……],"pic": [{"pic_id": "311","pic_name": "小女孩·柠檬汽水","price": "25.00","pic_url": "/data/files/store_238/pic/2015/06/201506160937045578.jpg", "collects": "1","views": "0","sales": "0","image_size": {"width": 2063,"height": 2063},"love": true //是否关注，true已关注，false未关注},{"pic_id": "314","pic_name": "小女孩·漫漫花事","price": "35.00","pic_url": "/data/files/store_238/pic/2015/06/201506161014059499.jpg", "collects": "1","views": "0","sales": "0","image_size": {"width": 2244,"height": 3488},"love": false}……],"products": [{"product_id": "176","product_name": "三脚猫原创手工皮革染色单肩包手工定制","price": "400.00","image_url": "/data/files/store_90/openshop/product_pic.JPG","collects": "1","views": "0","sales": "0","image_size": {"width": 3000,"height": 3000},"love": true //是否关注，true已关注，false未关注},{"product_id": "2066","product_name": "H.Cstudio 黑白拼色走秀款真丝缎面","price": "499.00","image_url": "/data/files/store_79/product/2015/06/201506150339342394.jpg","collects": "0","views": "0","sales": "0","image_size": {"width": 515,"height": 774},"love": false}……]},"result": {"start": 1,"count": 20}}正确返回码说明：加载更多商品URL：/index.php/index/load_more输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(partner+key)},"result": {"start": 21, //从第21条数据开始"count": 20 //总共返回20条数据，（即每页显示数量）}}返回码描述：错误码：参考头部信息校验统一错误码正确返回：{"head": {"code": "10000","msg": "数据获取成功"},"para": {"products": [{"product_id": "176","product_name": "三脚猫原创手工皮革染色单肩包手工定制","price": "400.00","image_url": "/data/files/store_90/openshop/product_pic.JPG","collects": "1","views": "0","sales": "0","image_size": {"width": 3000,"height": 3000},"love": true //是否关注，true已关注，false未关注},{"product_id": "2066","product_name": "H.Cstudio 黑白拼色走秀款真丝缎面","price": "499.00","image_url": "/data/files/store_79/product/2015/06/201506150339342394.jpg","collects": "0","views": "0","sales": "0","image_size": {"width": 515,"height": 774},"love": false}……]},"result": {"start": 21,"count": 20}}正确返回码说明：用户注册注册URL：/index.php/register/reg输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(mobile+pwd+cpwd+sms_captcha+nick_name+partner+key) },"para": {"mobile": "注册手机号","pwd": "密码","cpwd": "确认密码","sms_captcha": "手机接收的验证码","nick_name": "昵称"}}输入参数说明：返回码描述：错误码：{"head": {"code": "E0003","msg": "注册验证失败"}}{"head": {"code": "E0001","msg": "用户名已存在！"}}{"head": {"code": "E0001","msg": "两次密码不一致"}}正确返回：{"head": {"code": "10000","msg": "恭喜，注册成功！"},"para": {"user_name": "user","phone_mob": "user","nick_name": "oheyou","status": 1,"user_id": 263}}正确返回码说明：发送手机验证码URL：/index.php/register/send_sms_captcha 输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(partner+key)},"para": {"mobile": "用户手机号"}}输入参数说明：返回码描述：错误码：{"head": {"code": "E0005","msg": "手机号码不正确"}}正确返回：{"head": {"code": "10000","msg": "短信发送成功"}}真确返回码说明：用户中心登录URL：/index.php/user/login输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(user_name+pwd+partner+key)},"para": {"user_name": "用户名","pwd": "密码"}}返回码描述错误码：{"head": {"code": "E0003","msg": "用户名或密码错误！"}}正确返回：{"head": {"code": "10000","msg": "登录成功"},"para": {"user_id": "76","user_name": "user","nick_name": "oheyou","gender": "0","im_qq": "0","email":"****************","points": "0","portrait": "/data/files/usr/76/2015/05/201505140448321718.jpg","logins": "0","last_login": "1435226105","follow": "4", //关注数量"fans": "1", //粉丝数量"loves": "12", //喜欢数量（产品，图片，商品）"collects": "0" //店铺收藏数量}}正确返回码说明：登出URL：/index.php/user/login_out 输入参数：request={"head": {"key": "ldingadmin","mdkey": md5(partner+key)}}输入参数说明：返回码描述错误码：无正确返回：{"head": {"code": "10000","msg": "登出成功！"}}正确返回码说明：原产品产品列表URL：/index.php/product 输入参数：request={"head": {"key": "ldingadmin","mdkey": md5(cid+order+partner+key) },"para": {"cid": "分类id","order": "排序",},"result": {"start": "0","count": "20",}}输入参数说明：错误码：参考头部信息校验统一错误码正确返回：{"head": {"code": "10000","msg": "数据获取成功"},"para": [{"product_id": "2073","product_name": "HC STUDIO 黑色羊毛西装裤","add_time": "1434346771","price": "219.00","min_price": "219.00","max_price": "219.00","store_id": "79","store_name": "HC 定制工作室","image_url": "/data/files/store_79/product/2015/06/201506230847457013.png","view": "0", //浏览量"collects": "2", //收藏量"carts": "0", //加入购物车量"orders": "0", //下单量"sales": "0", //销售量"comments": "0", //评论量"love": false //是否喜欢},{"product_id": "2071","product_name": "HC STUDIO 优雅锦缎提花褶半身裙","add_time": "1434346569","price": "249.00","min_price": "249.00","max_price": "249.00","store_id": "79","store_name": "HC 定制工作室","image_url": "/data/files/store_79/product/2015/06/201506190721567528.jpg","view": "0","collects": "0","carts": "0","orders": "0","sales": "0","comments": "0","love": false},……],"result": {"start": 0,"count": 20}}产品详情URL：/index.php/product/detail 输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(product_id+partner+key)},"para": {"product_id": "产品id"},"result": { //用于评价和咨询"start": "0","count": "20",}}输入参数说明：错误码：参考头部信息校验统一错误码正确返回：{"head": {"code": "10000","msg": "数据获取成功"},"para": {"product_id": "134","product_name": "poly~(测试专用)","price": "0.01","default_image_id": "616", //商品主图id"image_url": "/data/files/store_76/openshop/product_pic.jpg", //商品主图地址"content": "啦啦啦啦啦啦", //商品详情"tags": [ //商品标签"连衣裙","雪纺","真丝","飘逸"],"brand_id": null, //商品品牌id"brand_name": null, //商品品牌名称"brand_logo": null,//商品品牌logo"store_id": "75", //店铺id"store_name": "awesome", //店铺名称"store_type": "1", //店铺类别1：个人2：公司"apply_type": "seller", //店铺申请类型seller：供应商designer：设计师"description": null, //店铺简介"store_collects": "0", //店铺收藏量"store_sales": "5", //店铺销售量"views": "0", //商品浏览量"carts": "7", //商品加入购物车量"collects": "2", //商品喜欢量"sales": "6", //商品销售量"comments": "0", //商品评论量"orders": "8", //商品下单量"product_loved": false, //是否喜欢过此商品（用户未登录一律返回false）"store_collected": false,//是否收藏过此店铺（用户未登录一律返回false）"spec_text": [ //商品规格描述{"spec_id": "80","spec_name": "颜色","is_color": "0","values": [{"spec_val_id": "23","sval_text": "白色","spec_val_text": "白色"},{"spec_val_id": "24","sval_text": "红色","spec_val_text": "红色"}]{"spec_id": "77","spec_name": "尺码","is_color": "0","values": [{"spec_val_id": "15","sval_text": "M","spec_val_text": "M"},{"spec_val_id": "16","sval_text": "L","spec_val_text": "L"}]}],"sku": { //商品sku";80:23;77:15;": {"sku_id": "541","price": "0.01","is_show": "1"},";80:23;77:16;": {"sku_id": "542","price": "0.01","is_show": "1"},";80:24;77:15;": {"sku_id": "543","price": "0.01","is_show": "1"},";80:24;77:16;": {"sku_id": "544","price": "0.01","is_show": "1"}},"images_datas": [ //商品其他部位图片地址{"image_url": "/data/files/store_75/product/2015/05/201505190926367050.jpg"{"image_url": "/data/files/store_75/product/2015/05/201505190927329810.jpg"}],"qa": [ //商品咨询数据{"reply_content": " hahahaha ","time_post": "1435200728","nick_name": "oheyou","portrait": "/data/files/usr/76/2015/05/201505140448321718.jpg"}],"comment": "" //商品评论数据（格式如咨询）},"result": {"start": 0,"count": 20}}正确返回码说明：分类树URL：/index.php/product/cate输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(partner+key)}}输入参数说明：返回码描述错误码：无正确返回：Json格式分类树正确返回码说明：备注：1000 操作成功。

接口文档的内容

接口文档的内容
修订历史
2、用户认证接口API
2.1请求消息体：
链接地址
链接地址
注：sign由channelId+key+timestamp+phone生成的字符串MD5加密生成，编码使用UTF-8。

key为权益中心提供给渠道方系统的一串需保密(不能向第三方透露)的字符串，请渠道方系统妥善保管。

2.2响应消息体：
{报文示例} 2.3错误码：
2.4业务交互流程：
详细交互流程：
1、用户在点击进入活动入口后，由渠道方服务端发起用户认证接口调用
2、中间账户平台收到服务端接口消息后，为用户分配token，并在接口响应中返回。

3、渠道方收到token后，在活动入口页面，加上token，结果：链接地址?token=XXX。

渠道方app引导app内用户页面访问：
链接地址?token=后面拼接接口获取到的token
4、中间账户平台在收到请求后，解析token，如果token有效或者存在，则直接展
示活动页面，否则将显示文本框输入界面
5、成功获取信息后，则自动登录注册成功，用户可以进行活动领取
6、url不携带token，无法获得用户信息，则不给用户展示页面。

简洁的接口文档模板

简洁的接口文档模板
1.接口概述
在这一部分，简要描述接口的作用、功能和目标。

2.接口说明
在这一部分，详细说明接口的参数、返回值、请求方式等。

2.1请求URL
描述接口的具体请求地址。

2.2请求方法
描述接口的请求方式，如GET、POST等。

2.3请求参数
列出接口的请求参数，包括参数名、类型、是否必填以及说明。

2.4响应
描述接口的响应结果，包括返回值类型、示例值以及说明。

3.接口示例
在这一部分，给出接口的示例请求和响应。

3.1请求示例
给出一个接口请求的示例，包括请求方法、URL和参数。

3.2响应示例
给出一个接口响应的示例，包括响应的状态码和返回结果。

4.错误码
在这一部分，列出接口可能返回的错误码和对应的错误信息。

5.版本记录
在这一部分，记录接口的版本更新历史。

5.1版本号
记录每个版本的版本号。

5.2变更内容
描述每个版本的新增、修改和移除的接口。

6.参考资料
在这一部分，列出接口设计过程中参考的资料和文档。

以上是一个简洁的接口文档模板。

通过这个模板，可以清晰明了地描
述接口的功能、参数、返回值以及示例，方便开发人员理解和使用接口。

同时，在错误码和版本记录部分，能够追踪和管理接口的错误和变更情况，保证接口的稳定性和可维护性。

软件开发-接口文档模版

TPDU
n10
HEX
预留：默认值 0x00，0x00，0x00，0x00，
0x00
消息类型
n4
BCD
0094
001
位元表(主)
b64
HEX
BIT MAP
位
定义
属性
编码格式
说明
002
交易处理码
n6
BCD
000094
003
网点编号
an32
ASCII
011
系统参照号
n16
BCD
终端或接入平台的唯一业务流水号
BCD
客服流水号
012
芯片损坏类型
an1
ASCII
0-可读；1-不可读
041
终端编号
an12
ASCII
064
MAC
b64
HEX
数据签名 MAC
返回报文格式
固定
报文长度
n4
HEX
不包括本数据项
TPDU
n10
HEX
预留：默认值0x00，0x00，0x00，0x00，
0x00
消息类型
n4
BCD
0096
001
057.06
支付方式
默认 00
00现金，01银联
057.07
是否记名
0 不记名 1记名
057.08
网点编码
057.09
操作员编码
057.10
卡押金
057.11
卡类型
从卡片中读取
064
MAC
b64
HEX
数据签名 MAC
返回报文格式
固定
报文长度
n4

接口文档(范例)

接口详细设计文档 (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 公共响应参数公共响应参数是指在每个接口的响应结果中都会返回的参数，例如状态码、错误信息等。

在该部分中，列举出每个公共响应参数的名称、类型和描述。

后台开发接口文档 - 模板

XXX接口开发文档1.接口规范接口的规范性会直接影响开发过程中的效率和质量。

本着快速高效开发的目的性，避免在开发过程中对接错误，从而降低错误率，提高开发效率。

遵循规范：(1) 遵循RESTful API设计风格(2) 数据格式采用json格式(3) 返回统一结构数据1.1.通用返回格式示例展示：1.2.通用返回错误码/*** 默认*/SUCCESS("00000", "操作成功"),/*** 通用错误值*/ERROR_COMMON("E0000", "错误"),ERROR_INPUT_TRANSFORM("E0006", "参数信息不合法"),ERROR_EMPTY_OBJECT("E0001", "对象为空"),ERROR_TIME_OUT("E0003", "当前请求过多，响应超时，请稍后重试"), ERROR_FALL_BACK("E0004", "服务被降级了"),/*** 系统异常system*///400SYS_BAD_REQUEST("400", "数据格式不正确"),SYS_UNAUTHORIZED("401", "登录凭证过期"),SYS_FORBIDDEN("403", "没有访问权限"),SYS_NOT_FOUND("404", "请求的资源不存在"),SYS_METHOD_NOT("405", "不支持当前请求方式"),SYS_MEDIA_TYPE_NOT("415", "请求内容类型错误"),// 500SYS_INTERNAL_SERVER_ERROR("500", "服务器内部错误"),SYS_SERVICE_UNAVAILABLE("503", "服务器正忙，请稍后再试"),/*** 数据库操作部分错误码：DB = Database*/DB_ERROR("DB000", "数据库错误"),DB_INSERT_ERROR("DB001", "新增数据错误"),DB_UPDATE_ERROR("DB002", "更新数据错误"),DB_DELETE_ERROR("DB003", "删除数据错误"),DB_PARAMETER_ERROR("DB004", "参数错误"),DB_INVALID_PARAMETER("DB005", "不合法的参数"), DB_MISS_PARAMETER("DB006", "缺少参数"),DB_REPEAT_RECORD("DB007", "重复记录"),/*** 用户模块错误码U = USER*/USER_NOT_EXISTS("U0001", "用户不存在"),USER_EXISTS("U0002", "用户已存在"),USER_PWD_WRONG("U0003", "用户或密码错误"),USER_NO_LOGIN("U0004", "未登录"),USER_TOKEN_INVALID("U0005", "凭证错误"),/*** 文件操作 F = FILE*/FILE_ERROR("F0001", "IO操作失败"),FILE_NOT_EXISTS("F0002", "文件不存在"),FILE_EXISTS("F0003", "文件已存在"),/*** 网络模块错误码N = NET*/NET_GATEWAY("N0001","网关异常"),NET_SENDING_FAILED("N0002","信息发送失败"); 2.XX服务提供的接口2.1.获取XX接口使用场景：①XXXXXXXXX。

1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。

1、查询结果按照创建时间排序显示。。。。。
项目名称
项目信息
功能描述：
【获取项目基本信息（整个项目信息模块的接口功能描述）】
返回说明：
参数名称
类型
描述
Code
String
状态码：
200成功
404错误
Msg
String
信息描述
Data
返回的数据
1.
【对标题接口必须有序号，方便后期的维护和修改跟进】【接口功能描述】
1.1、请求协议（https）
1.2、请求方式（GET）
project_location
project_sale返回信息
字段中文名
英文名
类型
业务补充描述
销售状态
sale_status
在售、待售、售完
project_location
字段中文名
英文名
类型
业务补充描述
经度
longitude
纬度
latitude
1.5、业务返回规则要求（业务方面的返回要求，比如查询结果按照时间排序之类的）
1.3、输入参数：
字段中文名
英文名
类型
是否必填
业务补充描述
项目ID
Proje回信息：
字段中文名
英文名
类型
业务补充描述
项目ID
Id
楼盘Code
f_house_code
项目名
prj_name
标签
prj_tags
开发商
developers
销售状态
project_sale
经纬度