restful风格接口

最新推荐文章于 2024-08-20 17:44:45 发布
最新推荐文章于 2024-08-20 17:44:45 发布
阅读量1.7k 收藏
点赞数
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/C18298182575/article/details/78679760
版权


关于什么是restful接口，资料解释遍地都是，自认为解释不清。现在只是记录一个普通的接口请求，在工作中见过不同人写的rest接口，风格不同，现在说说自己的看法。

两个问题：
一，Controller方法，以什么样的形式入参？实体封装参数 or 直接传递参数

二，rest风格接口，到底给请求方返回什么？越纯洁越好 or 除了请求json、xml数据还带上状态码，错误信息，成功失败标识。
比较以下案例：
A，1，2：包含异常码，状态码。4，只包含状态码。3，包含成功标识符，异常码，异常信息，时间撮。
B，1，2：把返回信息直接封装在一个实体中，没有定义泛型。4，用ResponseEntity接收响应数据。3，自定义泛型。

案例：
一，
(武汉公积金)
1，get方法：
@RequestMapping(value = "/gjjmp/{payCityID}_{idno}_{name}", method = RequestMethod.GET)
public IcsGjjMpCrResponse getGjjMpCr(@PathVariable String payCityID, @PathVariable String idno, @PathVariable String name) {}

2，post方法：
@RequestMapping(value = "/gjjmp")
public IcsGjjMpCrResponse checkGjjMpCr (@RequestBody IcsGjjMpCrRequest rq){}

1，2请求路径及参数
Http get：
http://10.14.15.216:8081/gjjmp/420100_420104197107260410_沈克

Http post：
http://10.14.15.216:8081/gjjmp/
Content-Type=application/json
{"payCityID":"420100","idno":"420104197107260410","name":"沈克","immediate":"t"}

（鹏元反欺诈）
3，get/post
@Controller
@RequestMapping("/credit")
public class PyCreditQueryController {

@RequestMapping(path = "/queryPy", method = {RequestMethod.GET, RequestMethod.POST})
@ResponseBody
public ResponseResult<CisReportRoot> queryPy(HttpServletRequest request,PyQueryBean pyQueryBean) {}
}

Http get：
http://10.14.15.216:8080/ics.credit/credit/queryPy?name=沈克&cardId=34122&phone=18298182579
Http post：与上类似

4，
    @RequestMapping(path = "/queryPy/{name}{cardId}{phone}", method = {RequestMethod.GET})

    public ResponseEntity<CisReportRoot> responseEntityStatusCode(@PathVariable String name, @PathVariable String cardId, @PathVariable String phone) {}

代码：

反欺诈：

@RequestMapping(path = "/queryPy{}", method = {RequestMethod.GET, RequestMethod.POST})
@ResponseBody
public ResponseResult<CisReportRoot> queryPy(HttpServletRequest request,PyQueryBean pyQueryBean) {
    ResponseResult<CisReportRoot> responseResult = new ResponseResult<>();
    try {
        CisReportRoot cisReportRoot = pyQueryService.queryCisReport(pyQueryBean);
        responseResult.setData(cisReportRoot);
        responseResult.setRefID(pyQueryBean.getRefID());
        responseResult.setTimestamp(DateUtil.getTimeStamp().toString());
        responseResult.setRet(SUCCESS);
    } catch (CreditException e) {
        responseResult.setErrorCode(e.getErrorCode());
        responseResult.setRet(SUCCESS);
        responseResult.setErrorMsg(e.getMessage());
    } catch (Exception e) {
        responseResult.setErrorCode(PyCreditServiceErrorEnum.SYSTEM_ERROR.getCode());
        responseResult.setRet(FAILED);
        responseResult.setErrorMsg(PyCreditServiceErrorEnum.SYSTEM_ERROR.getMsg());
    }
    return responseResult;
}

@RequestMapping(path = "/queryPy/{name}/{cardId}/{phone}", method = {RequestMethod.GET})
public ResponseEntity<CisReportRoot> responseEntityStatusCode(@PathVariable String name, @PathVariable String cardId, @PathVariable String phone) {
    CisReportRoot cisReportRoot = null;
    PyQueryBean pyQueryBean = new PyQueryBean();
    pyQueryBean.setName(name);
    pyQueryBean.setPhone(phone);
    pyQueryBean.setDocumentNo(cardId);
    try {
        cisReportRoot = pyQueryService.queryCisReport(pyQueryBean);
        // 如果不存在，返回404
        if (cisReportRoot == null) {
            return ResponseEntity.status(HttpStatus.NOT_FOUND).body(null);
        }
        return ResponseEntity.ok(cisReportRoot);
        //return new ResponseEntity<>(cisReportRoot, HttpStatus.OK);
    } catch (Exception e) {
        e.printStackTrace();
        // 如果有异常，返回500状态码
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(null);
    }
}
武汉公积金 

/**
 * controller主方法 POST
 * @param rq
 * @return
 */
@RequestMapping(value="/gjjmp")
public IcsGjjMpCrResponse checkGjjMpCr(@RequestBody IcsGjjMpCrRequest rq) {
   
   rq.setUuid(bean.getUuid());
   rq.setLocalServerInfo(bean.getLocalHost());
   
   logger.info("REQUEST [POST] "+ getURI()+ "BODY: " +DataConvert.toJson(rq));
   writeServerAccessLog(getURI(),"POST","ONCALL",DataConvert.toJson(rq));
   IcsGjjMpCrResponse rs = null;
   
   //平台服务类
   ISwitchService gjjApiService = serviceMap.get("checkMpRouting");

   //缓存服务类
   if (!"t".equalsIgnoreCase(rq.getImmediate())) {
      // 先调用缓存服务
      rs = cacheService.readCache(rq);
      if (rs != null) {
         writeServerAccessLog(getURI(),"POST","ONCACHE","RESPONSE:"+rs.getRspcode()+":"+rs.getRspMsg());
         logger.info("RESPONSE [POST] "+ getURI()+ "[CACHE] [RS_MSG]:"+rs.getRspcode()+":"+rs.getRspMsg());
         return rs;
      }
   }
   
   //DO REMOTE CALL
   rs = gjjApiService.callGjjCenterCheckMpAndConvert(rq);
   // 重新写缓存
   cacheService.writeCache(rs, rq);
   
   writeServerAccessLog(getURI(),"POST","ONRESPONSE","RESPONSE:"+rs.getRspcode()+":"+rs.getRspMsg());
   logger.info("RESPONSE [POST] "+ getURI()+ " [RS_MSG]:"+rs.getRspcode()+":"+rs.getRspMsg());
   return rs;
}

/**
 * controller主方法 GET
 * 
 * @return
 */
@RequestMapping(value = "/gjjmp/{payCityID}_{idno}_{name}", method = RequestMethod.GET)
public IcsGjjMpCrResponse getGjjMpCr(@PathVariable String payCityID, @PathVariable String idno, @PathVariable String name)
{
   logger.info(System.getProperty("user.home"));
   IcsGjjMpCrResponse rs = null;
   ISwitchService gjjApiService = serviceMap.get("checkMpRouting");
   IcsGjjMpCrRequest rq = new IcsGjjMpCrRequest();
   rq.setPayCityID(payCityID);
   rq.setIdno(idno);
   rq.setName(name);
   rq.setUuid(bean.getUuid());
   rq.setLocalServerInfo(bean.getLocalHost());
   
   String rqStr = DataConvert.toJson(rq);
   logger.info("REQUEST [GET] "+ getURI());
   writeServerAccessLog(getURI(),"GET","ONCALL", rqStr);
   //DO REMOTE CALL
   rs = gjjApiService.callGjjCenterCheckMpAndConvert(rq);
   
   // 重新写缓存
   cacheService.writeCache(rs, rq);
   writeServerAccessLog(getURI() ,"GET","ONRESPONSE","RESPONSE:"+rs.getRspcode()+":"+rs.getRspMsg());
   logger.info("RESPONSE [GET] [uri]:"+getURI() +" [RS_MSG]:" +rs.getRspcode()+":"+rs.getRspMsg()) ;
   return rs;
}
反欺诈调用方代码
/**

* public PYFQZPojo pojo = new PYFQZPojo();
    System.<span lang="EN-US" style="" font-size:"="">out.println("开始调用鹏元反欺诈接口---------------------------------------------------------------------------------");
    out.println(pyfqz_Url);
    JSONObject fraudRiskInfo=null,personRiskAssess=null;
    默认赋值未String zxCount="0",swCount="0",sxCount="0",wdyqCount="0",alCount="0",cqggCount="0";
    if"".equals(interfaceResult)){
        // 调用失败
        pojo.setMessage("{\"ret\":false,\"errorMsg\":\"接口调用失败，请核查连接信息"+pyfqz_Url+"\"}");
    else{
        JSONObject object = JSONObject.parseObject(interfaceResult);
        Boolean  ret = (Boolean) object.get("ret");
        if(!ret || (object.containsKey("errorMsg") && !"".equals(object.getString("errorMsg")))){
            pojo.setMessage(object.toString());
        }else{// 调用成功
            JSONObject data = (JSONObject) object.get("data");
            JSONObject reportElement = (JSONObject) ((JSONObject) data.get("cisReportChild")).get("reportElement");
           //是否命中欺诈风险名单 "state":"是否命中欺诈风险名单，取值：0/1，0表示未命中欺诈风险名单，1表示命中欺诈风险名单"
            if(reportElement.containsKey("fraudRiskInfo")){
                if(reportElement.containsKey("treatResult")){
                    if("1".equals(reportElement.get("treatResult"))){//直接从鹏元查数据
                        fraudRiskInfo =  (JSONObject) reportElement.get("fraudRiskInfo");
                    }else{
                       pojo.setMessage("{\"ret\":false,\"errorMsg\":\"来自鹏元无此节点值\"}");
                        return pojo;
                    }
                }else { // 直接从外联库中取
                    fraudRiskInfo =  (JSONObject) reportElement.get("fraudRiskInfo");
                }
            }
           //是否命中高风险名单 "checkResult":"是否命中高风险名单  1：是，2：否"
            if(reportElement.containsKey("personRiskAssess")){
                if(reportElement.containsKey("treatResult")){
                    if("1".equals(reportElement.get("treatResult"))){//直接从鹏元查数据
                        personRiskAssess =  (JSONObject) reportElement.get("personRiskAssess");
                    }else{
                       pojo.setMessage("{\"ret\":false,\"errorMsg\":\"来自鹏元无此节点值\"}");
                        return pojo;
                    }
                }else { // 直接从外联库中取
                    personRiskAssess =  (JSONObject) reportElement.get("personRiskAssess");
                }
            }
            //风险信息
            JSONObject personRiskInfo= null;
            if(reportElement.containsKey("personRiskInfo")){
                if(reportElement.containsKey("treatResult")){
                    if("1".equals(reportElement.get("treatResult"))){//直接从鹏元查数据
                        personRiskInfo =  (JSONObject) reportElement.get("personRiskInfo");
                    }else{
                       pojo.setMessage("{\"ret\":false,\"errorMsg\":\"来自鹏元无此节点值\"}");
                        return pojo;
                    }
                }else { // 直接从外联库中取
                    personRiskInfo =  (JSONObject) reportElement.get("personRiskInfo");
                }
            }
            zxCount = String.valueOf(personRiskInfo.get("zxCount"));
            swCount = String.valueOf(personRiskInfo.get("swCount"));
            sxCount = String.valueOf(personRiskInfo.get("sxCount"));
            wdyqCount = String.valueOf(personRiskInfo.get("wdyqCount"));
            alCount = String.valueOf(personRiskInfo.get("alCount"));
            cqggCount = String.valueOf(personRiskInfo.get("cqggCount"));
            pojo = JSONObject.toJavaObject(personRiskInfo,PYFQZPojo.class);
            pojo.setPersonRiskAssess(personRiskAssess.toString());
            pojo.setFraudRiskInfo(fraudRiskInfo.toString());
            pojo.setMessage( "{\"ret\":true}");
            return pojo;
        }
    }
    pojo;
<span lang="EN-US" font-size:10.5pt;font-family:consolas;"="">}

C18298182575
关注
RESTful风格接口-达摩院
weixin_44021967的博客
08-11 1287
07-01 RESTful简介 添加依赖：web，Rest Repositories，底层使用了Spring Data Jpa（data jpa 只需要添加一个依赖，不需要添加其他配置）（MyBatis（需要做一些配置）、Mongdb也可以） ，Mysql Driver 07-02 RESTful快速构建 全文搜索引擎Elasticsearch简介与实战：https://www.jianshu.com/p/d48c32423789 三个依赖：web、restful、elasticsearch @Docume
RESTful 风格接口书写方式
exlinker的博客
08-22 2689
文章目录1 使用 RESTful 风格接口书写方式1.1 简介1.2 五种请求方式1.3 需要注意的问题1.4 对照学习2 GET 请求参数详解2.1 参数拼接于路径中2.2 以键值对形式拼接于路径中2.2.1 普通单个参数2.2.2 普通多个参数2.2.3 自定义参数名称2.2.4 可缺省参数2.2.5 默认值参数2.2.6 接收数组参数2.2.7 使用 map 接收参数2.2.8 使用对象接收参数 1 使用 RESTful 风格接口书写方式 1.1 简介 RESTful 的核心思想就是，客户端发出的数据
restful 风格接口
qq_17335549的博客
04-10 567
HATEOAS 是 RESTful 架构的一个关键概念，它通过在资源表述中包含可用操作的链接，使得客户端能够动态地发现和执行操作，从而减少了客户端与服务器之间的依赖关系。总的来说，RESTful 规范是一种设计 API 的方法论，它通过一系列的约束和原则来促进系统的可伸缩性、可维护性和可移植性，使得系统更加灵活和易于扩展。：RESTful API 提供了统一的接口，包括标识资源的 URI、使用标准的 HTTP 方法对资源进行操作、通过媒体类型对资源进行表述等。
RESTful接口
最新发布
qq_67812668的博客
08-20 1269
统一接口为REST定义了对系统资源进行操作统一的方法和链接入口，REST架构的核心就是资源，它将互联网中所有的可访问、操作的数据信息都看作资源进行处理，从而简化了REST对不同数据信息的处理方式和过程，也为REST的高度 重用性以及不同分布式异构系统的高交互性奠定了基础。
什么是Restful接口
热门推荐
heroicpoem的专栏
07-28 1万+
1.rest的基础知识？ 是web服务的一种设计风格。是http动作与服务功能结合的创新。 简洁、容易理解、约定了规则。 实现： 1.用URI表示1种资源，只用名词表示资源，不要动作； 2.用http动作表示对资源的操作： get 查询 post insert put 更新 delete 删除 3.用http状态码表示结果 ** ps：做加法容易，做减法难。rest概念是http协议的主导者提出，创新的用了http动作表示服务动作。** 举例 我们使用HTTP的动词来操作用户这
restful接口
何惜戈
01-07 518
restful是一种软件架构设计风格，主要体现于资源描述，统一接口，url定位，无状态等方面。在rest风格中每一个具体信息都可以看作是一种资源，对资源的操作通过统一的接口来完成。http中的方法对应数据的增删改查，每一个资源都可以通过一个url来表示，通过url就可以访问资源。获取资源不依赖于其他的资源或状态，只通过url就可以实现定位。 一个restful风格的api可以实现对url的最大化...
vue 调用 RESTful风格接口操作
11-19
本篇将详细介绍如何在Vue项目中调用RESTful风格的接口进行CRUD（创建、读取、更新、删除）操作，并探讨相关技术点。 首先，让我们看下Java后端提供的RESTful接口示例： 1. 登录接口：使用`@GetMapping`注解，路径...
前端请求restful风格接口怎么传参_RESTful风格的API接口开发教程
weixin_42513152的博客
12-24 1723
写在前面的话网络程序正朝着移动设备的方向发展，前后端分离、APP，最好的交互交互方式莫过于通过API接口实现。既然要进行数据交互，那么这接口就得有讲究了：既要实用，又要优雅好看！那么，如何写一套漂亮的API接口呢？本次我们先了解一下Spring对API接口开发的支持，然后我们采用Spring Boot搭建项目，借用Swagger2列出API接口，便于查阅。返回格式API接口要求返回的格式是 app...
Django框架 - 16 Restful的使用一
韩波的博客
09-09 297
restful的使用1 前言 REST是所有Web应用都应该遵守的架构设计指导原则。 Representational State Transfer，翻译是”表现层状态转化”。 REST核心: 资源， 状态转移， 统一接口 资源: 是REST最明显的特征,是指对某类信息实体的抽象，资源是服务器上一个可命名的抽象概念，资源是以名词为核心来组织的，首先关注的是名词。 状态转移: ...
什么是Restful风格接口？
zheng2780071070的博客
12-24 7242
1.定义：Restful风格的API是一种软件架构风格，设计风格而不是标准，只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。 明确：他只是种代码风格的约束，而不是说非要这样干。 2.各个种类Mapping的作用： GetMapping （SELECT）：从服务器查询，可以在服务器通过请求的参数区分查询的方式。 POST（CREATE）：在服务器新建一个资源，调用insert操作。 PUT（UPDATE）：在服务器更新资源，调用update操作。 PA...
SpringBoot2.0基础案例(01)：环境搭建和RestFul风格接口
【积累】，是一个长期持续的过程。
06-07 1148
一、SpringBoot 框架的特点 SpringBoot2.0 特点 1）SpringBoot继承了Spring优秀的基因，上手难度小 2）简化配置，提供各种默认配置来简化项目配置 3）内嵌式容器简化Web项目，简化编码 Spring Boot 则会帮助开发着快速启动一个 web 容器，在 Spring Boot 中，只需要在 pom 文件中添加如下一个 starter-web 依赖即可. &l......
RESTful风格接口
小流年的专栏
02-20 603
RESTful风格接口
RESTful风格的接口
laoli360的博客
09-15 1601
普通接口设计 只用到get和post接口 接口的地址一般由动词+名词构成 每个接口的地址都不一样 例如： 接口名：localhost:8080/getarticle 类型：get 功能：获取文章信息 接口名：localhost:8080/addarticle 类型：post 功能：添加新文章 接口名：localhost:8080/delarticle 类型：post 功能：删除文章 接口名：localhost:8080/updatearticle 类型：post 功能：
RESTFUL风格的接口
beOkWithAnything
02-18 877
           
restful风格的接口设计
GEEK-BANANA
10-11 2736
1 为什么要用restful接口风格 restful的风格其实是一种规范，用来规范我们在写接口时的命名，用于前端与后端、项目与项目之间来传递数据。restful可以使我们的接口更加简洁、快捷高效、透明。 简洁：使用restful接口规范会使我们的接口名称的长度会变得更短，从而更加的简单清爽。 快捷高效：不管是前端的开发人员还是后端的开发人员，都可以根据接口的名称来得到接口的含义，进而也可以降低沟...
Restful 接口
beyond911的专栏
10-29 160
文章目录1.Introduction2. It contains following KB. 1.Introduction Restful is an API . In the sap , if external system give restful to me, we send data to it .we will use Restful interface. 2. It contains following KB. Uniform Resource Identifier . Resource
restful风格接口概述
hc_99999999的博客
03-07 319
原文链接http://blog.csdn.net/hzy38324/article/details/78360525?ticket=ST-26235-b31GSgT1oNr7zSmj0bIB-passport.csdn.net
SpringBoot RESTful接口
2302_76424895的博客
12-20 1827
RESTful（Representational State Transfer，表示状态转移）是一种软件设计风格，它使用HTTP 协议传输数据，并通过URL来标识资源的位置和状态。RESTful的核心思想是将网络资源视为一种状态，并通过HTTP协议来传输和操作这些状态2、RESTful的特点1.无状态协议：RESTful使用无状态协议，即服务器不维护与客户端的连接状态。每个请求都是独立的，可以轻松地支持并发请求和负载均衡。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值