引言

相关文档可查看 Flea RESTful接口规范.docx ，点击 View raw 即可下载

1. 总体概述

Flea RESTful 接口，即遵守REST式风格的接口，基于Jersey开发，遵循JAX-RS规范。接入 Flea RESTful 接口 的应用提供 RESTful Web Services（REST式的Web服务，它是一种遵守REST式风格的Web服务）。REST式的Web服务是一种ROA（Resource-Oriented Architecture, 面向资源的架构）的应用。其主要特点是方法信息存在于HTTP的方法中（比如GET、PUT、POST、DELETE），作用域存在于URI中。

2. 接口定义

2.1 接口协议

基于HTTP协议，接口完整报文支持XML和JSON，接口业务报文使用JSON。

2.2 交互编码

交互内容编码均采用 UTF-8 格式

2.3 接口地址

服务端地址/自定义部分 （http://ip:port/fleafs）
自定义部分 可见如下代码中 注解 ApplicationPath 内容

@ApplicationPath("/fleafs/*")
public class FleaFSResourceConfig extends FleaResourceConfig {

    public FleaFSResourceConfig() {
        super();
        // 设置 Jersey 过滤器配置文件 路径
        FleaJerseyFilterConfig.setFilePath("flea/jersey/fleafs-jersey-filter.xml");
    }
}

2.4 资源定义

以上传资源为例，如下贴出上传资源类，其中注解 Path 内容会追加到接口地址中来请求（http://ip:port/fleafs/upload）。

@Path("upload")
public class UploadResource extends FleaJerseyPostResource {

}

2.5 请求报文

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<JERSEY>
    <REQUEST>
        <PUBLIC>
            <SYSTEM_ACCOUNT_ID></SYSTEM_ACCOUNT_ID>
            <ACCOUNT_ID></ACCOUNT_ID>
            <RESOURCE_CODE></RESOURCE_CODE>
            <SERVICE_CODE></SERVICE_CODE>
        </PUBLIC>
        <BUSINESS>
            <INPUT>业务入参JSON报文</INPUT>
        </BUSINESS>
    </REQUEST>
</JERSEY>

公共报文 PUBLIC :

• SYSTEM_ACCOUNT_ID : 系统账户编号
• ACCOUNT_ID : 账户编号
• RESOURCE_CODE : 资源编码
• SERVICE_CODE : 服务编码

业务报文 BUSINESS :

• INPUT : 业务入参JSON报文

2.6 响应报文

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<JERSEY>
    <RESPONSE>
        <PUBLIC>
            <RESULT_CODE></RESULT_CODE>
            <RESULT_MESS></RESULT_MESS>
        </PUBLIC>
        <BUSINESS>
            <OUTPUT>业务出参JSON报文</OUTPUT>
        </BUSINESS>
    </RESPONSE>
</JERSEY>

公共报文 PUBLIC :

• RESULT_CODE : 返回码
• RESULT_MESS : 返回信息

业务报文 BUSINESS :

• INPUT : 业务出参JSON报文

3.返回码定义

Flea RESTful接口资源服务提供方，如果出现异常，应当抛出异常对应的国际码，同时在Flea Jersey 国际码和错误码映射表【flea_jersey_i18n_error_mapping】中配置异常国际码和错误返回码的映射关系，其中异常国际码由各资源服务提供方自行配置并使用、错误返回码统一按下面的规范定义。

目前，错误返回码包含如下分类：

以下是将你提供的数据转换为 Markdown 格式后的内容：

3.1. 成功

3.2. Flea Jersey接口服务端的过滤器错误返回码

3.3. Flea Jersey接口服务端的业务异常错误返回码