E-Lin通用微服务平台-Oracle SQL脚本注册Restful API服务

最新推荐文章于 2022-08-04 15:59:39 发布
最新推荐文章于 2022-08-04 15:59:39 发布
阅读量486 收藏 2
点赞数
分类专栏： E-lin通用微服务平台
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/chenxianping/article/details/113812235
版权

       通过注册Oracle SQL脚本就可以实现简单返回查询结果的Restful API服务，无需编写Java的Entity、Dao、Services和Controller等等类，也无需编译、部署和发布包和程序，减少60%到80%以上的工作量，注册就可以发布Restful API服务
      注意重点：Oracle SQL脚本不能有回车换行符。否则无法调用创建通用API。
      
一、Oracle SQL无参数脚本
以如下Oracle SQL脚本为例：

SELECT Owner
      ,Object_Name
      ,Object_Type
  FROM Dba_Objects
 WHERE Owner = 'CRM'

1.1 注册通用Restful API对象：CRM_CUSTOM_OBJECT
请求URL：http://localhost:6602/db/api/apiobject/add
请求方法:POST
请求报文为JSON格式参考如下：

{
    "apiCode": "CRM_CUSTOM_OBJECT",
    "description": "查询E-Lin CRM自定义数据对象&<>'\"",
    "objectName": "SELECT Owner,Object_Name,Object_Type FROM Dba_Objects WHERE Owner = 'CRM'",
    "dataObjectType": 1,
    "dataSourceId": 2,
    "enabledFlag": true,
    "dataSourceName": "ELIN_CRM"
}

注意：请求报文中的有特殊字符。
提交请求响应报文如下：

{
    "success": true,
    "message": "New success!",
    "code": 200,
    "timestamp": 1613486589972,
    "result": {
        "apiId": 39,
        "apiCode": "CRM_CUSTOM_OBJECT",
        "description": "查询E-Lin CRM自定义数据对象&<>'\"",
        "owner": null,
        "packageName": null,
        "objectName": "SELECT Owner,Object_Name,Object_Type FROM Dba_Objects WHERE Owner = 'CRM'",
        "overLoad": null,
        "dataObjectType": 1,
        "callScripts": "SELECT Owner,Object_Name,Object_Type FROM Dba_Objects WHERE Owner = 'CRM'",
        "dataSourceId": 2,
        "serviceId": null,
        "enabledFlag": true,
        "queryResultFlag": false,
        "dataSourceName": "ELIN_CRM",
        "dataBaseType": 1,
        "argumentCount": 0,
        "sequenceName": "CRM_COMMMON_IFACE_S"
    }
}


1.2 调用通用查询Restful服务：
请求URL：http://localhost:6602/db/api/callquery?apiCode=CRM_CUSTOM_OBJECT
请求方法:POST
请求报文:{}
请求响应报文件参考下:

二、带参数Oracle SQL脚本
以如下Oracle SQL脚本为例：

SELECT Org_Type
      ,Org_Name
      ,Org_No
      ,Name_Pinyin
  FROM Oa_Sys_Org_Element
 WHERE Org_No = :1
    OR :2 IS NULL

2.1 注册通用Restful API对象：
请求URL：http://localhost:6602/db/api/apiobject/add
请求报文为JSON格式参考如下，其中:1和:2表示二个参数。apiCode表示通用Restful API的代码。

{
    "apiCode": "OA_FIND_ORG",
    "description": "查询OA用户信息",
    "objectName": "SELECT Org_Type ,Org_Name ,Org_No ,Name_Pinyin FROM Oa_Sys_Org_Element WHERE Org_No = :1 Or :2 IS NULL",
    "dataObjectType": 1,
    "dataSourceId": 2,
    "enabledFlag": true,
    "dataSourceName": "ELIN_CRM"
}

提交请求响应报文如下：

{
    "success": true,
    "message": "New success!",
    "code": 200,
    "timestamp": 1613475770814,
    "result": {
        "apiId": 37,
        "apiCode": "OA_FIND_ORG",
        "description": "查询OA用户信息",
        "owner": null,
        "packageName": null,
        "objectName": "SELECT Org_Type ,Org_Name ,Org_No ,Name_Pinyin FROM Oa_Sys_Org_Element WHERE Org_No = :1 Or :2 IS NULL",
        "overLoad": null,
        "dataObjectType": 1,
        "callScripts": "SELECT Org_Type ,Org_Name ,Org_No ,Name_Pinyin FROM Oa_Sys_Org_Element WHERE Org_No = :1 Or :2 IS NULL",
        "dataSourceId": 2,
        "serviceId": null,
        "enabledFlag": true,
        "queryResultFlag": false,
        "dataSourceName": "ELIN_CRM",
        "dataBaseType": 1,
        "argumentCount": 0,
        "sequenceName": "CRM_COMMMON_IFACE_S"
    }
}


2.2 添加通用Restful API的参数：
请求URL：http://localhost:6602/db/api/oraargs/batchadd
请求报文为JSON格式参考如下：

[
  {
    "apiId": 37,
    "argumentKey": "orgNo1",
    "argumentName": "ORG_NO1",
    "dataType": "VARCHAR2",
    "description": "员工工号1",
    "inOut": "IN",
    "javaType": 12,
    "position": 1
  },{
    "apiId": 37,
    "argumentKey": "orgNo2",
    "argumentName": "ORG_NO2",
    "dataType": "VARCHAR2",
    "description": "员工工号2",
    "inOut": "IN",
    "javaType": 12,
    "position": 1
  }
]

提交请求响应报文如下：

{
    "success": false,
    "message": "Batch added successfully[2],failure[0]",
    "code": 500,
    "timestamp": 1613476146649,
    "result": {
        "success": [
            {
                "apiId": 37,
                "subprogramId": 0,
                "argumentName": "ORG_NO1",
                "position": 1,
                "sequence": 0,
                "dataLevel": 0,
                "dataType": "VARCHAR2",
                "defaulted": null,
                "defaultValue": null,
                "defaultLength": 0,
                "inOut": "IN",
                "dataLength": 0,
                "dataPrecision": 0,
                "dataScale": 0,
                "radix": 0,
                "characterSetName": null,
                "typeOwner": null,
                "typeName": null,
                "typeSubname": null,
                "typeLink": null,
                "plsType": null,
                "charLength": 0,
                "charUsed": null,
                "argumentKey": "orgNo1",
                "description": "员工工号2",
                "javaType": 12
            },
            {
                "apiId": 37,
                "subprogramId": 0,
                "argumentName": "ORG_NO2",
                "position": 1,
                "sequence": 0,
                "dataLevel": 0,
                "dataType": "VARCHAR2",
                "defaulted": null,
                "defaultValue": null,
                "defaultLength": 0,
                "inOut": "IN",
                "dataLength": 0,
                "dataPrecision": 0,
                "dataScale": 0,
                "radix": 0,
                "characterSetName": null,
                "typeOwner": null,
                "typeName": null,
                "typeSubname": null,
                "typeLink": null,
                "plsType": null,
                "charLength": 0,
                "charUsed": null,
                "argumentKey": "orgNo2",
                "description": "员工工号2",
                "javaType": 12
            }
        ]
    }
}

2.3 查看通用Restful API的OA_FIND_ORG的实例：
请求URL：http://localhost:6602/db/api/exmaple/OA_FIND_ORG,参考如下:

2.4 调用通用Restful API服务：
请求URL：http://localhost:6602/db/api/callquery?apiCode=OA_FIND_ORG
请求方式：POST
请求报文如下：

{
    "orgNo1": "",
    "orgNo2": ""
}

请求响应报文如下图：

或者参考如下：

三、Oracle EBS 初始化多组织访问和职责上下文的SQL脚本
以Oracle EBS系统的PO标准采购订单题头视图查询为例：

SELECT Pha.Segment1 Po_Number
      ,Revision_Num
      ,Vendor_Name
      ,Pha.Creation_Date
  FROM Po_Headers_v Pha
 WHERE Pha.Org_Id = :1
   AND (Pha.Creation_Date >= :2)

3.1 注册通用Restful API对象：
请求URL：http://localhost:6602/db/api/apiobject/add
请求方法：POST
请求报文参考如下，其中:1为业务实体ID参数和:2为订单创建日期参数

{
    "apiCode": "EBS_PO_HEADERS_QUERY",
    "description": "查询Oracle EBS采购订单题头",
    "objectName": "SELECT Pha.Segment1 Po_Number,Revision_Num,Vendor_Name,Pha.Creation_Date FROM Po_Headers_v Pha WHERE Pha.Org_Id = :1 AND (Pha.Creation_Date >= :2)",
    "dataObjectType": 1,
    "enabledFlag": true,
    "dataSourceName": "ELIN_EBS_UAT"
}

提交请求响应报文参考如下：

{
    "success": true,
    "message": "New success!",
    "code": 200,
    "timestamp": 1613490267483,
    "result": {
        "apiId": 42,
        "apiCode": "EBS_PO_HEADERS_QUERY",
        "description": "查询Oracle EBS采购订单题头",
        "owner": null,
        "packageName": null,
        "objectName": "SELECT Pha.Segment1 Po_Number,Revision_Num,Vendor_Name,Pha.Creation_Date FROM Po_Headers_v Pha WHERE Pha.Org_Id = :1 AND (Pha.Creation_Date >= :2)",
        "overLoad": null,
        "dataObjectType": 1,
        "callScripts": "SELECT Pha.Segment1 Po_Number,Revision_Num,Vendor_Name,Pha.Creation_Date FROM Po_Headers_v Pha WHERE Pha.Org_Id = :1 AND (Pha.Creation_Date >= :2)",
        "dataSourceId": 3,
        "serviceId": null,
        "enabledFlag": true,
        "queryResultFlag": false,
        "dataSourceName": "ELIN_EBS_UAT",
        "dataBaseType": 1,
        "argumentCount": 0,
        "sequenceName": "EBS_COMMMON_IFACE_S"
    }
}


3.2 添加通用Restful API对象EBS_PO_HEADERS_QUERY参数：
请求URL：http://localhost:6602/db/api/oraargs/batchadd
请求方法：POST
请求报文参考如下：

[
  {
    "apiId": 42,
    "argumentKey": "orgId",
    "argumentName": "ORG_ID",
    "dataType": "NUMBER",
    "description": "业务实体ID",
    "inOut": "IN",
    "javaType": 4,
    "position": 1
  },{
    "apiId": 42,
    "argumentKey": "creationDate",
    "argumentName": "Creation_Date",
    "dataType": "DATE",
    "description": "创建日期",
    "inOut": "IN",
    "javaType": 91,
    "position": 2
  }
]

请求响应报文参考如下：

{
    "success": false,
    "message": "Batch added successfully[2],failure[0]",
    "code": 500,
    "timestamp": 1613490363842,
    "result": {
        "success": [
            {
                "apiId": 42,
                "subprogramId": 0,
                "argumentName": "ORG_ID",
                "position": 1,
                "sequence": 0,
                "dataLevel": 0,
                "dataType": "NUMBER",
                "defaulted": null,
                "defaultValue": null,
                "defaultLength": 0,
                "inOut": "IN",
                "dataLength": 0,
                "dataPrecision": 0,
                "dataScale": 0,
                "radix": 0,
                "characterSetName": null,
                "typeOwner": null,
                "typeName": null,
                "typeSubname": null,
                "typeLink": null,
                "plsType": null,
                "charLength": 0,
                "charUsed": null,
                "argumentKey": "orgId",
                "description": "业务实体ID",
                "javaType": 4
            },
            {
                "apiId": 42,
                "subprogramId": 0,
                "argumentName": "Creation_Date",
                "position": 2,
                "sequence": 0,
                "dataLevel": 0,
                "dataType": "DATE",
                "defaulted": null,
                "defaultValue": null,
                "defaultLength": 0,
                "inOut": "IN",
                "dataLength": 0,
                "dataPrecision": 0,
                "dataScale": 0,
                "radix": 0,
                "characterSetName": null,
                "typeOwner": null,
                "typeName": null,
                "typeSubname": null,
                "typeLink": null,
                "plsType": null,
                "charLength": 0,
                "charUsed": null,
                "argumentKey": "creationDate",
                "description": "创建日期",
                "javaType": 91
            }
        ]
    }
}


3.3 查看通用Restfull API服务EBS_PO_HEADERS_QUERY实例
请求URL:http://localhost:6602/db/api/exmaple/EBS_PO_HEADERS_QUERY
请求方法：POST
请求响应报文参考如下：

{
    "creationDate": "2021-02-16 23:28:50",
    "orgId": 0
}


注意：参数日期格式必须为YYYY-MM-DD HH:MM:SS。
3.4 调用通用Restful API服务EBS_PO_HEADERS_QUERY。
请求URL:http://localhost:6602/db/api/callebsquery?apiCode=EBS_PO_HEADERS_QUERY
请求方法：POST
请求报文参考如下：

{
	"applInitialize": {
		"applShortName": "PO",
		"orgId": 81,
		"respApplId": 201,
		"respId": 50626,
		"userId": 1450
	},
	"arguments": {
		"creationDate": "2020-10-01 00:00:00",
		"orgId": 81
	}
}

提交请求响应报文参考如下：

注意：日期字段默认返回为Timestamp,若想返回年月日时分秒，则需求要通过To_Char转换以字符串类型返回值。
 

AlanChen
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
专栏目录
oracle调用restful服务,Oracle REST Data Services(ORDS)-经过REST接口操做Oracle数据库
weixin_39740419的博客
04-02 1072
简介ORDS，Oracle REST Data Services，经过一个java中间层应用，将HTTP(S)动词(GET，POST，PUT，DELETE等)等REST接口映射到数据库事务，并返回使用JSON格式化的任何结果。html 基本要求：以java服务独立运行或经过支持javaEE的应用程序服务器，如WebLogic，GlassFish，Tomcat。java下载和安装1.从oracle...
SQLer：无需编程语言即可将SQL查询转换为RESTful API的工具
cpongo011702
03-19 531
SQLer是一个微型http服务器，用Go语言编写，将旧的CGI概念应用于SQL查询。SQLer允许编写端点并分配一个SQL查询，以便任何人点击它时能执行查询。此外SQLer还允许自定义验证规则，可验证请求正文或查询参数。SQLer使用nginx样式配置语言（HCL）。SQLer功能无需依赖，可独立使用；支持多种数据可类型，包括：SQL Server, MYSQL, SQLITE, Postgre...
一个快速实现SQL转Restful微服务接口的工具
08-09
一个快速实现SQL转Restful微服务接口的工具
E-Lin通用微服务平台-Oracle存储过程注册Restful API服务(一)
陈显平的专栏-Oracle EBS
02-17 679
Oracle存储过程注册Restful API服务。存储过程通过输出游标参数返回查询结果,节省75%~90%以上工作量
无需编程，基于甲骨文oracle数据库零代码生成CRUD增删改查RESTful API接口
crudapi的博客
04-08 559
无需编程，基于甲骨文oracle数据库零代码生成CRUD增删改查RESTful API接口 回顾 通过之前一篇文章 无需编程，基于PostgreSQL零代码生成CRUD增删改查RESTful API接口 的介绍，采用抽象工厂设计模式，已经支持了大象数据库PostgreSQL。之前通过字符串拼接生成DDL SQL语句，比较繁琐。本文开始，引入了FreeMarker模版引擎，通过配置模版实现创建和修改物理表结构SQL语句，简化了大量代码，提高了效率，并且通过配置oracle数据库SQL模版，基于oracle数据
基于Flask的RESTful API实战代码：集成Flask-SQLAlchemy与MySQL
最新发布
03-25
项目概述：本项目是一个基于Python语言的实战项目，使用了Flask框架构建RESTful API。它集成了Flask-SQLAlchemy作为ORM工具与MySQL数据库进行交互。项目共包含39个文件，其中主要的Python脚本文件有23个，辅助配置...
e-commerce-rest-api:Java和Scala中的简单RESTful API
04-28
这是Java中的一个简单的RESTful API项目。 REST API代表电子商务应用程序的基本操作。 该项目的目的是学习REST，这就是为什么该项目被分成多个分支，并且各个阶段的进度不同。 只是我们的REST资源的类图和路由。 ...
springboot-restful-starter：SpringBoot RESTful API脚手架
02-05
springboot-restful-starter SpringBoot RESTful API脚手架简介这是一个基于SpringBoot 2.1.1 RELEASE ，用于构建RESTful API工程的脚手架，只需三分钟你就可以开始编写业务代码，不再烦恼于建造项目与风格统一。...
spring-boot-api:spring-boot 通用APP后端api接口 restful api接口 前后分离后端接口
05-01
Spring Boot restful api 形式接口 适用于APP后端接口服务 前后端分离项目提供接口服务 集成jpa（Java持久层API）ORM jpa的curd 原生curd MySQL分页 阿里数据库连接池druid 封装腾讯云CMQ相关接口 redis相关接口API ...
Python-带RESTfulAPI的自托管文档转换服务
08-10
带RESTful API的自托管文档转换服务
【SQLFLow】使用SQLFLow的RESTFul接口
m0_54252387的博客
07-20 456
通过SQLFlow提供的一系列restful接口可以在我们的程序中操作获取到我们想要分析的SQL脚本的分析结果。SQLFlow。
使用PL/SQL来创建RESTful Web Services
cpuku88442的专栏
07-31 206
Reference: https://docs.oracle.com/cd/E56351_01/doc.30/e87809/installing-REST-data-services.htm#AELIG7217 ...
命令行使用oracle19c_Oracle 19c给我的启示：RESTful API
weixin_39732866的博客
12-22 141
这是学习笔记的第 2113 篇文章最近Oracle发布了19c,而且随着Openworld的到来，官网也提前做了更新，打开Oracle官网，让我一脸懵逼，鼠标不知道该往哪儿点。整个页面是这样的风格，也没有了原本的导航等。认真看了下标题介绍，那我就选择一个和我贴近的吧，就点击了Infrastructure,按照这个定义，现在已然是2.0时代了。不过随着这些链接点进去，看到了一系列的关于自治数据库的介...
原生sql实现restful接口调用
weixin_33754913的博客
02-26 882
index.php <?php include './Request.php'; include './Response.php'; //获取数据 $data=Request::getRequest(); $result=Response::sendResponse($data); echo $result; ?> Request.php <?...
使用SQLFLow的RESTFul接口
学习之余随便记记
05-24 5691
SQLFlow的restful接口 我们不光可以在SQLFlow图形化界面上使用，还可以通过SQLFlow提供的一系列restful接口进行使用，目前SQLFlow提供很多接口供第三方调用。 接口文档 使用案例 通过SQLFlow的api实现从对指定SQL脚本文件进行分析并得到分析结果。 java实现版本 sqlflow调用 import com.alibaba.fastjson.JSONObject; import org.apache.http.HttpEntity; import org.apac
oracle将restful接口封装到视图中
贤时间
08-04 351
oracle环境下有时候会需要访问到第三方发布webservice接口，有时候我们突发奇想，要是访问这些接口就如访问本地表一样就好了，如下是实现方法。
E-Lin通用微服务平台-数据源维护
陈显平的专栏-Oracle EBS
02-15 478
本章主要讲解Oracle数据库的数据源新增、修改和查找服务的操作实例。
Oracle REST Data Services (ORDS) 学习笔记（一）REST和RESTful相关知识理解
I am HadesZ，我是金瀚海
02-28 3649
业务系统资源整合和外部数据接入都会用到接口数据，有的人会说提供数据一方有开放接口，接收数据一方有接收接口，但是在我个人理解提供数据才是接口，而最常见的就是RESTful架构形式，在Oracle官网又看到不需接口开发直接配置的Oracle REST Data Services 即ORDS，使我更加想深入了解什么是REST和RESTful呢？介于C站知识丰富，汇总和吸收了相关知识点，如有不正之处欢迎...
将数据库 自动生成restful接口的工具 Xmysql
popstarqq的博客
07-19 1645
工具地址：https://github.com/o1lab/xmysql 一分钟配置，相当方便，需要在nodejs环境运行
ruoyi-vue-pro的微服务
07-28
1. 注册中心服务（Eureka、Consul等）：用于服务的注册与发现，管理各个微服务的注册信息。 2. 网关服务（Zuul、Spring Cloud Gateway等）：用于统一管理请求入口，实现路由转发和负载均衡等功能。 3. 配置中心...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

AlanChen

您的鼓励是我创作的源泉

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值