API文档模板
XX项目接口文档一.版本信息
二.接口说明
1.获取XX列表
Api地址：
参数定义：
接口返回：
1 / 1
API接口文档
API接口文档 最后更新日期：2013-05-16 一、添加域名接口 (6) 1、接口调用地址 (6) 2、传入参数 (6) 3、输出数据 (6) 二、删除域名接口 (7) 1、接口调用地址 (7) 2、传入参数 (7) 3、输出数据 (7) 三、添加用户接口 (8) 1、接口调用地址 (8) 2、传入参数 (8) 3、输出数据 (8) 四、获取用户信息接口 (9) 1、接口调用地址 (9) 2、传入参数 (9) 3、输出数据 (9) 五、搜索用户接口 (10) 1、接口调用地址 (10) 2、传入参数 (10) 3、输出数据 (10) 六、修改用户接口 (11) 1、接口调用地址 (11) 2、传入参数 (11) 3、输出数据 (12) 七、删除用户接口 (13) 1、接口调用地址 (13) 2、传入参数 (13) 3、输出数据 (13) 八、获取邮箱别名接口 (14) 1、接口调用地址 (14) 2、传入参数 (14) 3、输出数据 (14) 九、获取部门列表接口 (15) 1、接口调用地址 (15) 2、传入参数 (15) 3、输出数据 (15) 十、添加部门接口 (17) 1、接口调用地址 (17)
3、输出数据 (17) 十一、修改部门接口 (18) 1、接口调用地址 (18) 2、传入参数 (18) 3、输出数据 (18) 十二、删除部门接口 (19) 1、接口调用地址 (19) 2、传入参数 (19) 3、输出数据 (19) 十三、获取部门成员接口 (20) 1、接口调用地址 (20) 2、传入参数 (20) 3、输出数据 (20) 十四、添加部门成员接口 (21) 1、接口调用地址 (21) 2、传入参数 (21) 3、输出数据 (21) 十五、删除部门成员接口 (22) 1、接口调用地址 (22) 2、传入参数 (22) 3、输出数据 (22) 十六、添加别名接口 (23) 1、接口调用地址 (23) 2、传入参数 (23) 3、输出数据 (23) 十七、修改别名接口 (24) 1、接口调用地址 (24) 2、传入参数 (24) 3、输出数据 (24) 十八、删除别名接口 (25) 1、接口调用地址 (25) 2、传入参数 (25) 3、输出数据 (25) 十九、获取POP接收邮件接口 (26) 1、接口调用地址 (26) 2、传入参数 (26) 3、输出数据 (26) 二十、添加POP接收邮件接口 (27) 1、接口调用地址 (27) 2、传入参数 (27) 3、输出数据 (27) 二十一、修改POP接收邮件接口 (28) 1、接口调用地址 (28)
开发接口文档-API文档模板
XXX项目接口文档版本控制信息 获取所有字段 获取所有字段 请求地址：/session/field/findAll 请求参数 响应
请求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！ ","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconColour":"","iconSize":0,"ico nStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"iconColour":"","iconSize":0,"iconSty le":"","id":7,"name":"XX"}]},"totals":0} 文件上传 文件上传（ajax） 请求地址：/session/file/upload 请求参数 响应 请求例子：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和filePath 字段管理-所属类型 新增所属类型 请求地址：/session/fieldType/save 请求参数 响应 请求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}
API 接口 设计文档 模板
Dream调试工具DLL接口文档 文件状态：[√] 草稿[ ] 正式发布[ ] 正在修改当前版本： 1.0 作者：ChunFeng Li 文件密级：[ ]普通[√]秘密[ ]绝密 文档版本 版本/状态作者参与者日期说明 1.0 ChunFeng Li ChunFeng Li 2016-04-13 设备只能发现串口连接的设备，指 令只能下发单条修改 一、DLL初始化 1.描述 调用所有接口之前需要先调用初始化接口。 2.接口名（dll导出名） Dream_Init() 3.请求参数说明 参数字段必选类型限制说明 _net_point True int<65535 Udp广播端口号 _com_rate True int 38400 连接串口的默认波特率 _call_back True Void* ... 异步消息回调（详细见第五条：回调函数） 4.返回参数说明 a.返回类型Int :0成功-1重复初始化 二、获取最新设备列表 1.描述 调用该接口获取所有当前在线列表。 2.接口名（dll导出名） Dream_GetDeviceList() 3.请求参数说明
char_buf True char* 1024 存放返回数据的内存指针，空间大小有调 用方分配 buf_len True int 1024 分配的空间大小 4.返回参数说明 a.返回类型Int : 返回数据长度。 b.返回数据结构:”1000,COM3\r\n1001,COM5\r\n1002,192.168.0.118\r\n”。 [ID,Name\r\n]为一个设备，以后有跟多设备详细信息，往后接。 三、发送指令消息 1.描述 下发数据和读取数据指令都通过该接口实现。(阻塞方式调用函数) 2.接口名（dll导出名） Dream_SendAction() 3.请求参数说明 参数字段必选类型限制说明 device_id True int>1000 发送消息的设备ID例如1000 _ChannelCode True int 0-0xFF 通道编码：例如0x10 _FunctionCode True int 0-0xFF 功能编码，不同的编码对应不同的功能_FunctionNumber True int 0-0xFF 功能编号，标记当前编码对应不同的功能data_msg True char* 发送指令的data，没有数据为NULL，如 果是单个数据：12.1，如果是整组数据： 12.1,1,0,...... 按顺序逗号隔开的连续字符 time_out True int 20*N 接口调用超时时间，单位毫秒 out_buf True char* 存放返回数据的内存指针，空间大小有调 用方分配 buf_max_len True int 分配的空间大小 4.返回参数说明 a.返回类型Int : 返回数据长度。如果为0,表示超时或网络异常 b.返回的数据结构：如果是下发数据，返回的是成功和失 败；”ACK”,”NAK”,”NO_CMD”,”ERROR”,”TimeOut”,如果是读取数据，返回的是数据， 例如12.1，或数据组12.1,12.2,1,1.2..... 四、DLL初始化 1.描述 下发数据和读取数据指令都通过该接口实现。(非阻塞方式调用函数) 2.接口名（dll导出名） Dream_SendAction() 3.请求参数说明
京东API接口整理
1、类目API 获取商家类目信息 获取类目属性 通过类目属性ID获取属性值列表 设置商家级别的类目销售属性值 添加商家商品销售属性 更新商家商品销售属性 获取类目属性列表 获取类目属性值 获取单个类目信息 查找子类目列表 查询商家已授权的品牌 数据结构 item_cat categoryAttr类目属性对象 attrFeature类目属性特殊属性 categoryAttrGroup属性分组 attrGroupFeature属性分组特殊属性 categoryAttrValue类目属性值对象 attrValueFeature类目属性特殊属性 feature特殊属性 wareaddvender_sellsku添加商家商品销售属性
wareupdatevender_sellsku更新商家商品销售属性 brandList商家品牌List集合 2、店铺API 京东店铺API，包含提供商家、商家店铺基本信息及店内分类操作查询等功能。 添加卖家自定义店内分类 更新商家自定义店内分类 删除商家自定义店内分类 获取前台展示的商家自定义店内分类 查询商家基本信息 店铺信息查询 查询退货地址列表 查询发货地址列表 3、商品API 提供网站商品信息更新、查询API,该组下所有接口均不支持自营店铺业务 1. 新增商品 修改商品 商品上架 商品下架 删除商品信息 根据商品ID查询单个商品的详细信息 批量获取商品信息 检索商品信息
获取商品上架的商品信息 获取商品下架的商品信息 根据商品Id，销售属性值Id查询图片根据商品Id，销售属性值Id增加图片根据商品Id，销售属性值Id删除图片根据商品Id，销售属性值Id设置图片根据商品Id，检索商品图片 设置商品限购区域 查询商品限购区域 添加商品关联版式 修改商品关联版式 删除商品关联版式 查询关联版式id以及名称 查询关联版式详情 设置关联版式到商品 增加SKU信息 修改SKU信息 修改SKU库存信息 修改SKU价格信息 删除SKU 信息 根据外部ID获取商品SKU 根据商品ID列表获取商品SKU信息 获取单个SKU信息 回复商品评价 查询商品评价信息列表
api接口文档
API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。API除了有应用“应用程序接口”的意思外，还特指API的说明文档，也称为帮助文档。 API：应用程序接口（API：Application Program Interface） 应用程序接口（是一组定义、程序及协议的集合，通过API 接口实现计算机软件之间的相互通信。API 的一个主要功能是提供通用功能集。程序员通过调用API 函数对应用程序进行开发，可以减轻编程任务。API 同时也是一种中间件，为各种不同平台提供数据共享。 根据单个或分布式平台上不同软件应用程序间的数据共享性能，可以将API 分为四种类型： 远程过程调用（RPC）：通过作用在共享数据缓存器上的过程（或任务）实现程序间的通信。 标准查询语言（SQL）：是标准的访问数据的查询语言，通过数据库实现应用程序间的数据共享。 文件传输：文件传输通过发送格式化文件实现应用程序间数据共享。
信息交付：指松耦合或紧耦合应用程序间的小型格式化信息，通过程序间的直接通信实现数据共享。 当前应用于API 的标准包括ANSI 标准SQL API。另外还有一些应用于其它类型的标准尚在制定之中。API 可以应用于所有计算机平台和操作系统。这些API 以不同的格式连接数据（如共享数据缓存器、数据库结构、文件框架）。每种数据格式要求以不同的数据命令和参数实现正确的数据通信，但同时也会产生不同类型的错误。因此，除了具备执行数据共享任务所需的知识以外，这些类型的API 还必须解决很多网络参数问题和可能的差错条件，即每个应用程序都必须清楚自身是否有强大的性能支持程序间通信。相反由于这种API 只处理一种信息格式，所以该情形下的信息交付API 只提供较小的命令、网络参数以及差错条件子集。正因为如此，交付API 方式大大降低了系统复杂性，所以当应用程序需要通过多个平台实现数据共享时，采用信息交付API 类型是比较理想的选择。 API 与图形用户接口（GUI）或命令接口有着鲜明的差别：API 接口属于一种操作系统或程序接口，而后两者都属于直接用户接口。 有时公司会将API 作为其公共开放系统。也就是说，公司制定自己的系统接口标准，当需要执行系统整合、自定义和程序应用等操作时，公司所有成员都可以通过该接口标准调用源代码，该接口标准被称之为开放式API。
开发接口API模板
XXX项目接口文档 版本控制信息 1获取所有字段 1.1获取所有字段 请求地址：/session/field/findAll 请求参数 响应 响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconColour":"",
"iconSize":0,"iconStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"icon Colour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0} 2文件上传 2.1文件上传（ajax） 请求地址：/session/file/upload 请求参数 响应 请求例子：var formData = new FormData(); formData.append("file", this.files[0]); $.ajax({ url : routePath + "/session/file/upload", type : 'POST', data : formData, processData : false, contentType : false, success : function(result) { result = JSON.parse(result); if(result.code == "10000"){
java开发接口文档模板
竭诚为您提供优质文档/双击可除java开发接口文档模板 篇一：java的接口与实例 一、定义 java接口（interface），是一系列方法的声明，是一些方法特征的集合，一个接口只有方法的特征没有方法的实现，因此这些方法可以在不同的地方被不同的类实现，而这些实现可以具有不同的行为（功能）。 接口定义的一般形式为： [访问控制符]interface{ 类型标识符final符号常量名n=常数； 返回值类型方法名([参数列表]); … } 二、接口的特点 1、java接口中的成员变量默认都是 public,static,final类型的(都可省略),必须被显示初始化,即接口中的成员变量为常量(大写,单词之间用"_"分隔) 2、java接口中的方法默认都是public,abstract类型
的(都可省略),没有方法体,不能被实例化 3、java接口中只能包含public,static,final类型的成员变量和public,abstract类型的成员方法 4、接口中没有构造方法,不能被实例化 5、一个接口不能实现(implements)另一个接口,但它可以继承多个其它的接口 6、java接口必须通过类来实现它的抽象方法 7、当类实现了某个java接口时,它必须实现接口中的所有抽象方法,否则这个类必须声明为抽象类 8、不允许创建接口的实例(实例化),但允许定义接口类型的引用变量,该引用变量引用实现了这个接口的类的实例 9、一个类只能继承一个直接的父类,但可以实现多个接口,间接的实现了多继承. 三、接口的用法 1、精简程序结构，免除重复定义 比如，有两个及上的的类拥有相同的方法，但是实现功能不一样，就可以定义一个接口，将这个方法提炼出来，在需要使用该方法的类中去实现，就免除了多个类定义系统方法的麻烦。举例：鸟类和昆虫类都具有飞行的功能，这个功能是相同的，但是其它功能是不同的，在程序实现的过程中，就可以定义一个接口，专门描述飞行。 下图是分别定义鸟类和昆虫类，其都有飞行的方法。
Json接口文档
文档 [ { [ID](int):编号, [NodeName](string):节点名称 [NodeNo](int):节点编号, [ProductID](int):产品编号, [Remark](string):备注, [GatewayNo](string):网关编号, [AreaID](int):区域编号, [X]:, [Y]:, [Longitude](string):经度, [Latitude](string):纬度, [Extern](string):备用字段, [Type](string):类型, [Installation](string):安装地点, [Color](string):颜色, [CropsNames](string):作物, [GreenhousesID](int):大棚编号 }, .... ] [ { [SENSOR_ID](int):传感器编号, [SENSOR_SHOW_NAME](string):传感器名称, [PORT_SHOW_NAME](string):传感器显示名称,
[UNIT](string):单位, [Accuracy](string):准确性, [ParentID](int):父节点编号, [Code](string):代码, [Level](int):层级, [Color](string):颜色 }, …. ] [ { [ID](int):编号, [SRC_NAME](string):节点名称, [TIME_STAMP](datetime):时间, [NODE_ID](int):节点编号, [CHANNEL](int):, [SENSOR_ID](int):传感器编号, [DATA](double):数值, [LIVE](int):层级 }, .... ] [ { [节点编号](int):, [安装地点](string):, [更新时间](datetime):, [湿度](string):, [温度](string):, [气压](string):, [降雨量](string):, [风向](string):,
开发接口文档API文档模板
X X X项目接口文档版本控制信息 1获取所有字段 1.1获取所有字段 请求地址：/session/field/findAll 请求参数 响应 响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！ ","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconColour":"", "iconSize":0,"iconStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"icon Colour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0} 2文件上传
2.1文件上传（ajax） 请求地址：/session/file/upload 请求参数 响应 请求例子：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"){ ('上传成功！'); } } });
开发接口 API 模板
XXX项目接口文档版本控制信息 1获取所有字段 1.1获取所有字段 请求地址：/session/field/findAll 请求参数 响应
请求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconColour":"", "iconSize":0,"iconStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"icon Colour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0} 2文件上传 2.1文件上传（ajax） 请求地址：/session/file/upload 请求参数 响应 请求例子：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和filePath 3字段管理-所属类型 3.1新增所属类型 请求地址：/session/fieldType/save 请求参数 响应
SolidWorks API接口的应用
SolidWorks API接口的应用 SolidWorks API是SolidWorks的OLE应用程序开发接口，用户可以利用它和支持OLE编程的开发工具，如VB、VBA(Excel, Access)、C、VC++等对SolidWorks进行二次开发，建立适合用户需要的、专用的SolidWorks 功能模块。 一、问题的提出 大多数工程图纸的标题栏中应该包括一些基本的设计信息，如零件名称、零件代号、材料以及设计人员和设计日期等，其中，零件的名称、代号、材料、数量、重量及一些重要的后处理要求等信息还应该出现在装配图的材料明细表(BOM)中。这些内容如果在工程图中一一进行编写和修改，其工作量是很大的，并且这种处理方法也不利于保证设计信息的一致性，对模型文件(零件或装配体文件)和图纸文件的管理来讲是脱节的。SolidWorks是一个全相关的三维机械设计软件，模型文件中的设计数据，如尺寸、注释、文件属性等内容与工程图相关，因此，我们在处理上述工程图标题栏和材料明细表中的设计数据时，应该将这些内容保存在模型文件中，并且自动显示在工程图相应的位置上。当需要对工程图中的内容进行修改时，直接修改模型文件中的相应数据即可实现。 这样的处理方法不仅保证了设计信息的一致性，而且可以大大提高设计效率。根据这个设想，笔者将这些设计信息进行了归纳，并将它们作为模型文件的自定义属性保存在模型文件指定配置的属性(在SolidWorks中，选择菜单"文件→属性"，单击"
指定配置"标签，如图1所示)中，针对模型文件指定配置的这些属性可以自动带入到工程图的标题栏和材料明细表。 对于材料明细表模板进行修改或建立新的明细表模板就可以在装配图中的材料明细表中显示所需要的设计信息(工程图格式文件的定义和材料明细表模板的定义，请参阅《SolidWorks2001中文版实用技术精粹》一书)。因此，无论何时需要修改设计信息，只需在SolidWorks中打开相应的模型文件，修改指定配置属性即可。然而，即使采用这样的处理方法，在修改文件当前配置属性时仍然显得有些繁琐，能否为SolidWorks建立一个工作界面，可以更加方便地添加和修改这些信息就成了问题的关键。 二、自定义属性Cpbom 为了更大程度地提高工作效率，我们利用VB6.0通过SolidWorks API建立了自定义属性设置程序--Cpbom，这个程序通过一个对话界面直接对当前模型文件的当前配置进行添加或修改，其基本功能如下： ☆针对配置添加模型文件的自定义属性; ☆设置的项目包括：零件代号、材料名称、后处理、设计者姓名、设计日期; ☆确定自定义属性后，自动保存文件;如当前文件还没有保存，提示文件保存路径和文件名称; ☆针对装配文件，可以选择是否删除"材料"和"后处理"两个属性。本程序利用VB进行编译生成可执行文件。自定义属性界面"自定义属性"程序就是通过SolidWorks API对当前模型文件中当前配置的自定义属性的名称和值进行"读"和"写"的操作，程序非常简单，这里介绍一下该程序中用到的一些SolidWorks API的对象和方法。 1.SolidWorks对象这里指的是SolidWorks API的最高级别的对象。通过该对象可以控制SolidWorks软件的执行或退出，以及SolidWorks文件的建立、打开、关闭等操作。在VB中利用CreateObject方法来获得SolidWorks对象，利用该对象的ac tivedoc方法可以获得当前SolidWorks文件对象，文件对象为空时，表示SolidWorks 没有打开任何文件。 Dim swApp As ObjectDim activeDocument As ObjectSet swApp=CreateObject("SldWorks.Application")
API 接口 设计文档 模板
Dream调试工具DLL接口文档文件状态：当前版本： 1.0 [√] 草稿作者： ChunFeng Li [ ] 正式发布 [ ] 正在修改文件密级： [ ]普通[√]秘密 [ ]绝密文档版本版本/状态作者参与者日期说明 1.0 ChunFeng Li ChunFeng Li 2016-04-13 设备只能发现串口连接的设备，指令只能下发单条修改 一、DLL初始化 1.描述调用所有接口之前需要先调用初始化接口。 2.接口名（dll导出名） Dream_Init() 3.请求参数说明参数字段必选类型限制说明True int _net_point <65535 Udp广播端口号True int _com_rate 38400 连接串口的默认波特率True Void* _call_back ... 异步消息回调（详细见第五条：回调函数） 4.返回参数说明 a. 返回类型Int :0成功 -1重复初始化二、获取最新设备列表 1.描述调用该接口获取所有当前在线列表。 2.接口名（dll导出名）Dream_GetDeviceList() 3.请求参数说明 参数字段必选类型限制说明True char* char_buf 1024 存放返回数据的内存指针，空间大小有调用方分配 True int buf_len 1024 分配的空间大小 4.返回参数说明a. 返回类型Int : 返回数据长度。b. 返回数据结构:”1000,COM3\r\n1001,COM5\r\n1002,192.168.0.118\r\n”。[ID,Name\r\n]为一个设备，以后有跟多设备详细信息，往后接。 三、发送指令消息1.描述下发数据和读取数据指令都通过该接口实现。(阻塞方式调用函数) 2.接口名（dll导出名）