用友NCC产品API使用指南 二维码
114
来源：轻易云 open api简介Open API即开放API,也称开放平台。 所谓的开放API（OpenAPI）是服务型网站常见的一种应用，网站的服务商将自己的网站服务封装成一系列API（Application Programming Interface，应用编程接口）开放出去，供第三方开发者使用，这种行为就叫做开放网站的API，所开放的API就被称作OpenAPI（开放API）。 就现在互联网上Open API的形态来看，主要分成两种：标准REST和类REST(也可以叫做RPC形态)。 REST形态主要有这么几点特点： 1.服务地址就是资源定位地址。 2.服务操作就是Http请求中的方法类型（GET,POST,DELETE,PUT），这其实是抽象现实当中对于服务的增删改查操作。 UAP实现open apiRestlet项目为“建立REST概念与Java类之间的映射”提供了一个轻量级而全面的框架。 UAP在Restlet框架之上，选择了官方JAX-RS扩展，并且在扩展的基础上与NC进行了集成。 主要jar包modules/uapws/pubuapfw_restframeworkLevel-1.jar NC使用Restlet框架需要修改nchome/hotwebs/nccloud/WEB-INF/web.xml文件。增加以下两个配置
业务组open api开发步骤1. 创建资源创建资源类xxResource 继承AbstractNCCRestResource 通过注解的方式开发，restlet通用注解包含如下： 在ncc中要求rest请求类型只能是post
2. 资源注册和upm文件类似，创建的资源需要在配置文件中进行注册。注册方式：在META-INF下创建.rest文件，将创建的资源全限定类名注册到.rest文件中。
注：和upm文件一样，此文件在运行时必须包含在nchome/modules/XX/META-INF下
3．编写md文档（api使用说明）1. 在openapi组件下META-INF同级目录下创建hotwebs文件夹。
2. 在hotwebs文件夹下按照nccloud/resources/api/modules/模块/组件/帮助文档.md的目录结构创建帮助文档文件
3. 在注册openpi的时候，需要填写访问路径和文档路径，文档路径需要从模块开始具体到md文件，例如：样例中的文档路径应该填写为/aim/equip/equip.md 4．预制api脚本1.在环境路径http://ip:port/nccloud/resources/opm路径下注册api相关信息，包括：api所属模块，api所属实体，api访问路径，api帮助文档路径等。（具体操作和规范参见openapi配置中心使用文档） 2.将注册的api脚本抽取出来作为预制脚本提交到盘里（注意脚本中的访问路径要和md文档中的访问路径一致；脚本中api帮助文档地址要和第三步文档路径一直）
open api 开发规范1. 资源包命名规范：ncc.openapi.模块.业务组件.业务操作 示例：ncc.openapi.aum.borrow.apply(借用申请) 2．资源类命名规范：业务组件+业务操作+Resources(驼峰命名) 示例：BorrowApplyResources 3．uri定义：nccloud/api/模块/业务组件/业务操作/动词 （增：add;删除：delete；查询：query；修改：update (其他业务动词自定义)） 示例：http://ip:port/nccloud/api/aum/borrow/apply/query(查询借用申请) 4.md文档语法规范：（md文档的名称不要重复） a.文档名称用一号字【#】，一级目录用二号字【##】，三级目录使用三号字【###】以此类推。 b.请求地址前加【>】地址内容必须和注册的api脚本访问路径一致。格式：http://ip:port/apiUrl.(如：http://ip:port/nccloud/api/fip/service/add) c.表格的格式：表头内容必须用【|】包起来，第二行必须跟上【|---|---|---|】表头有几列加几个。 d.请求参数和返回值参数的写法：如果是主子表格式的，在3.3中描述参数分类，如：head,body。分别在3.3.1和3.3.2中描述head和body的内容。如下图
e．json示例：json示例以【请求参数json示例】和【返回值json示例】命名。用【```】包起来，内容必须是标准json格式的数据。 Openapi测试Openapi测试参见openapi使用文档。你也可以使用轻易云数据集成平台进行测试
|
