GithubHelp home page GithubHelp logo

Comments (2)

zxacc1991 avatar zxacc1991 commented on June 2, 2024

数据市场功能介绍

数据市场的功能主要包含两个部分:数据接口和数据服务,当然还有很多功能(字段脱敏,调用日志等)是对前面两者功能的赋能增强,下面我们来逐一进行介绍。
一. 数据接口
数据接口主要是针对已有数据源进行接口配置,可对单表或者多表进行配置,形成API对外开放调用,同时也会对API的调用频率以及接口鉴权进行管理。下面我们来详细介绍一下。

1. 数据接口介绍
1.1 属性配置
点击接口新增,在属性配置页面中可填写API的调用路径,请求方式,返回格式,还可以根据实际情况来配置接口的限流频率以及IP黑名单。

注意:这里的API版本以及API路径会形成接口的调用路径,后面接口调用时会提及。

如下图所示:
接口新增

1.2 执行配置
执行配置页面中可以填写配置方式(表引导模式/脚本模式),数据源,数据库表以及字段列。我们可以按照配置方式拆分为两种进行介绍。
1.2.1 表引导模式
表引导模式可以选择已有数据源中的某张表进行接口入参、出参的配置,如下图所示:
表引导模式1

选择好入参出参后点击下一步,会进入参数配置,这里可以配置入参、出参的描述,默认值等属性。(这里需要全部填写,不然会报错)
如下图所示:
参数配置

配置好参数,点击右上角保存即可。

1.2.2 脚本模式
在第二步中如果我们选择脚本模式的话,需要再选择一个数据源,然后进行自定义的SQL编写。这种模式可以进行多表关联查询,灵活性较高。
如下图所示:
表引导模式sql

SQL编写好后点击SQL解析按钮,再点击下一步进入属性配置页面,该页面与表引导模式相同,可以参照上面的描述。

1.2.3 接口发布
接口配置完成后,返回接口列表界面,选择已配置的接口,点击“操作”按钮,选择发布,接口即可上线使用。

2. 接口调用介绍
根据上述步骤,我们可以配置一个接口,那么下面我们就来介绍如何进行接口调用的介绍。
2.1 接口调用参数查看
在接口详情中,我们可以看到右上角有接口示例,
如下图所示:
接口示例

点击接口示例后,就会跳转至接口调用参数的界面,
如下图所示:
接口参数
入参

上图中的调用路径:/services/v1.0/data/query 就是我上述操作配置的接口URI。

这里api_key和secret_key是接口的鉴权参数,ACCOUNT_ID是接口的入参。

需要注意,虽然我们接口中配置的入参只有ACCOUNT_ID,但是系统默认需要带上pageNum与pageSize字段,不然会报错!!!

请求示例:

1)请求URL:http://{ip}:{port}/services/v1.0/data/query
2)header参数:
        api_key:uIPhPFuFlhGQvTHDP0W7QaxkMxp/B1bs
        secret_key:P07BXDeCIWA=
3)请求入参:
        {
              "ACCOUNT_ID":"10000",
              "pageSize":"10",
              "pageNum":"1"
        }
4)输出参数:
        {
          "success":true,
          "code":200,
          "msg":"操作成功",
          "data":{
                   "pageNum":1,
                   "pageSize":20,
                   "total":1,
                   "data":[
                         {
                               "ACCOUNT_PARENT":"100",
                              "ACCOUNT_DESCRIPTION":"该账号为测试账号",
                              "ACCOUNT_TYPE":"游客",
                              "ACCOUNT_ROLLUP":"1000"
                         }
                   ]
           }
        }

注意:这里的ip为你服务器上部署data-market-service-mapping的ip,port的话默认为8823。

二. 数据服务

from alldata.

alldatafounder avatar alldatafounder commented on June 2, 2024

LGTD, 感谢您,可以提交PR合并到alldata/develop分支,respect!!

from alldata.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.