5.API文档发布.doc

广东同望科技股份有限公司 第  PAGE 9 页 共  NUMPAGES 9 页 V平台webapi接口格式说明 银弹谷V平台部 2016/2/22  目录  TOC \o 1-3 \h \z \u  HYPERLINK \l _Toc444695580 V平台webapi接口格式说明  PAGEREF _Toc444695580 \h 1  HYPERLINK \l _Toc444695581 银弹谷V平台部  PAGEREF _Toc444695581 \h 1  HYPERLINK \l _Toc444695582 1. 概述  PAGEREF _Toc444695582 \h 4  HYPERLINK \l _Toc444695583 1.1 构件API的一般访问形式  PAGEREF _Toc444695583 \h 4  HYPERLINK \l _Toc444695584 1.2 构件API的定义  PAGEREF _Toc444695584 \h 4  HYPERLINK \l _Toc444695585 1.3 构件API的版本  PAGEREF _Toc444695585 \h 4  HYPERLINK \l _Toc444695586 1.4 HTTP请求格式的一般约定  PAGEREF _Toc444695586 \h 5  HYPERLINK \l _Toc444695587 2. 安全控制  PAGEREF _Toc444695587 \h 5  HYPERLINK \l _Toc444695588 3. 构件API输入参数  PAGEREF _Toc444695588 \h 5  HYPERLINK \l _Toc444695589 3.1 定义  PAGEREF _Toc444695589 \h 5  HYPERLINK \l _Toc444695590 4. 返回数据格式  PAGEREF _Toc444695590 \h 6  HYPERLINK \l _Toc444695591 4.1 HTTP响应头  PAGEREF _Toc444695591 \h 6  HYPERLINK \l _Toc444695592 4.2 执行结果  PAGEREF _Toc444695592 \h 7  HYPERLINK \l _Toc444695593 5. API文档发布  PAGEREF _Toc444695593 \h 7  概述 构件是V平台的功能包装单元，系统的主要业务功能通过构件自身、以及构件之间的协作完成。 构件内可通过配置方式对外提供具体的业务API，构件API通过HTTP调用方式对外公开。 构件API除了从属于某一个构件、有一个标识名称以外，构件API还从属于某一个命名空间，命名空间用于对API进行适当的归类，以便于管理和使用。 命名空间 + API名称，构成了构件API的唯一标识。 构件API的一般访问形式 构件API访问形式，类似： http://*****:**/context/webapi/VBASE/WORKFLOW/DEFINITION/CreateWorkflowDefinition 其中，*****:**指应用所在的域名及端口； context指应用上下文； webapi是固定的api标识； VBASE/WORKFLOW/DEFINITION指API的命名空间，命名空间可以在开发系统中，定义业务API的时候设定； CreateWorkflowDefinition指具体的API名称 构件API的定义 构件API的版本 一般情况下，为了维持构件API的稳定性以及易用性，通常API需要做到向下兼容，即：相同API标识（构件名+命名空间+API名称）下，其输入参数和返回值格式是稳定的。如果需要增加额外参数，可以在API实现中对新添加的参数做兼容处理。 此外，如果需要支持同一API的不同版本，可以通过在命名空间中加入版本分段的方式来间接达到区分API版本的效果。 例如：某命名空间定义为：v1/WORKFLOW/DEFINITION 那么，其访问的URL为： http://*****:**/context/webapi/VBASE/v1/WORKFLOW/DEFINITION/CreateWorkflowDefinition HTTP请求格式的一般约定 HTTP