flea-jersey使用之Flea RESTful接口介绍

简介: 本篇介绍 Flea框架下 flea-jersey 模块下的 Flea RESTful接口

《开发框架-Flea》

image.png

引言

相关文档可参考 Flea RESTful接口规范.docx ,点击 View raw 即可下载

image.png

1. 总体概述

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

2. 接口定义

2.1 接口协议

基于HTTP协议,业务出入参报文支持 XMLJSON

2.2 交互编码

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

2.3 接口地址

服务端地址/自定义部分 (http://ffs.huazie.com/fleafs)
自定义部分 可见如下代码中 注解 ApplicationPath 内容

/**
 * <p> FleaFS 资源入口 </p>
 *
 * @author huazie
 * @version 1.0.0
 * @since 1.0.0
 */
@ApplicationPath("/fleafs/*")
public class FleaFSResourceConfig extends FleaResourceConfig {
   
   

    /**
     * <p> 无参构造方法 </p>
     *
     * @since 1.0.0
     */
    public FleaFSResourceConfig() {
   
   
        super();
    }
}

2.4 请求报文

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

2.5 响应报文

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<JERSEY>
    <RESPONSE>
        <PUBLIC>
            <RESULT_CODE></RESULT_CODE>
            <RESULT_MESS></RESULT_MESS>
        </PUBLIC>
        <BUSINESS>
            <OUTPUT>业务出参JSON报文或XML报文</OUTPUT>
        </BUSINESS>
    </RESPONSE>
</JERSEY>
目录
相关文章
|
3天前
|
XML 开发框架 JSON
flea-jersey使用之Flea RESTful接口客户端接入
本篇介绍 Flea框架下的 flea-jersey-client模块,并提供客户端依赖管理及接入步骤
34 1
flea-jersey使用之Flea RESTful接口客户端接入
|
3天前
|
开发框架 API 网络架构
flea-jersey使用之Flea RESTful接口服务端接入
本篇介绍 Flea框架下的 flea-jersey-server模块,并提供服务端依赖管理及接入步骤
35 1
flea-jersey使用之Flea RESTful接口服务端接入
|
3天前
|
JSON Go 数据格式
golang学习7,glang的web的restful接口结构体传参
golang学习7,glang的web的restful接口结构体传参
|
3天前
|
JSON Go 数据格式
golang学习6,glang的web的restful接口传参
golang学习6,glang的web的restful接口传参
|
3天前
|
JSON Go 数据格式
golang学习5,glang的web的restful接口
golang学习5,glang的web的restful接口
|
3天前
|
前端开发 API 网络架构
RESTful接口与http协议状态表述
该文介绍了RESTful风格API的好处和设计原则。RESTful API以资源为中心,通过HTTP方法(GET, POST, PUT, DELETE)表示操作,利用状态码反馈操作结果。它简化了客户端与服务端的交互,提供了一种通用规范,减少沟通成本。设计要点包括:URI描述资源,HTTP方法体现操作,使用标准HTTP状态码,GET不改变数据,使用复数名词,支持复杂资源关系,可选实现HATEOAS,以及接口版本管理。
|
3天前
|
NoSQL Java API
java一行代码实现RESTFul接口
Spring Data REST是构建在Spring Data之上的库,可自动将repository转换为REST服务,支持JPA、MongoDB、Neo4j、GemFire和Cassandra。无需手动创建Service和Controller层。要开始,需配置JPA数据源,创建实体类和Repository接口。快速实现REST接口,只需引入spring-boot-starter-data-rest Maven依赖,并在Repository接口上添加@RepositoryRestResource注解。
|
3天前
|
前端开发 API 网络架构
Python 如何开发出RESTful Web接口,DRF框架助力灵活实现!
Python 如何开发出RESTful Web接口,DRF框架助力灵活实现!
|
3天前
|
Cloud Native Go 数据库
一文搞懂Go搭建Restful接口
一文搞懂Go搭建Restful接口
20 0
|
XML 缓存 JSON
前后端分离开发,RESTful 接口应该这样设计
前后端分离开发,RESTful 接口应该这样设计
353 0
前后端分离开发,RESTful 接口应该这样设计