使用APISQL平台快速生成API接口教程_通过sql生成api-程序员宅基地

技术标签： fastapi  oneapi  yapi  API  

首先感谢您使用APISQL云平台，您在使用过程中有什么问题可及时跟我们联系，我们会及时为您解答。

第1章 简介

1.1 平台操作流程

流程

温馨提示：在登陆平台后，建议先参考示例，感受一下系统主要功能。

APISQL云平台与企业私有版功能是一样，只是企业版是完全安装在企业内网，或运行在企业自己的云服务器。

1.2 客服支持

在使用过程中，如出现功能报错、无法访问等异常，请通过下列方式联系我们

联系方式

微信扫一扫，添加工作人员的微信时，请备注：APISQL，拉你入用户群。

1.3 文档更新

对于内网环境下的用户，您可以离线使用本帮助文档。这些文档可能会过时，无法反映最新的功能和信息。如果用户想要查看最新的文档，请用浏览器访问平台的官方网站
http://www.apisql.cn

第2章 注册登陆

2.1 注册

APISQL云平台的注册地址：https://open.apisql.cn/ui/register

邮箱不用认证

注册

登陆后如下界面
登陆

2.2 体验演示项目

可以先体验一下演示项目
体验演示

【运行】一个已发布的API
运行

切换到【接口设计】，可以看到SQL脚本很简单：SELECT * FROM area
接口设计

再进一级，只是使用一个参数【:province_name】，参数类似是string，值为：陕西省
参数

第3章 安装数据网关

3.1 创建项目

创建一个【测试项目】
新建项目

3.2 安装网关

数据网关 中【新建网关】，勾选 示例数据 就是上一章看到，包含一个SQLite数据库的行政区域表
新建网关

根据您的操作系统，下载相应的客户端程序。以下以Windows平台为例。
下载客户端

下载安装客户端时，会有如下提示，选择仍要运行
仍要运行

填写上文的值

APISQL_NODE_ID（网关ID）

APISQL_NODE_TOKEN（网关Token）

网关ID、网关Token

选择要安装的位置，下一步

安装位置

下一步

安装中

完成

安装完成

3.3 增加数据源

刷新平台，看到运行时，就可以增加数据源了
增加数据源

选择你的MySQL类、PostgreSQL类、SQL Server、Oracle、SQLite数据库，后续根据用户需求和反馈放，支持更多国产信创数据库、OLAP分析型数据库、NoSQL型数据库；以及开放数据源的功能，支持用户以插件方式连接更多的数据源。

可选配置，支持开发、生产多环境的场景。

数据源连接

第4章 设计API

4.1 创建API接口组

新建一个API接口组
新建API接口组

4.2 调试SQL

接口设计，配置个接口路径、然后编辑调试SQL
API设计

这里是调试SQL界面

  • 左侧： 查询网关、数据库、表名、字段；
  • 上侧： 选择数据源；
  • 中间： SQL编辑区，
  • 右侧： SQL参数修改区；
  • 下侧： 执行结果

SQL调试器界面

4.3 SQL参数

您可以在SQL语句中使用【:】后跟参数名称来定义参数，然后在 右侧 的 【SQL参数】 区域选择相应的 【数据类型】

【默认值】：会影响正式开发的API和调试界面；当参数为空会提示"message": “参数异常,缺少参数 ‘xx’”。

【示例值】：只用于接口调试界面使用给开发人员使用，优先级更高。
SQL参数说明

SQL调试器编辑完成即可发布，但不能被调用，出于安全原则，必须指定访问策略，详见下一章节。

带参API设计完成

第5章 访问控制

API 访问控制策略对于保护数据和确保系统安全至关重要。通过适当的身份验证、限制访问及密钥管理等方法，可以实现有效的 API 访问控制。防止未经授权的个人或系统对数据进行修改、删除或盗取。

访问控制策略是与API组分开设置的，您需要将访问控制策略与API组进行绑定，才能使该策略对该API组有效。

5.1 新建策略

认证类型

  • 不鉴权(公开)： 接口组中的所有接口将不再验证访问者身份(任何人可访问)， 多用于初期测试，请务必注意数据安全。
    不鉴权(公开)策略

  • API key： API Key 会创建一个秘钥，接口访问时携带此秘钥即可。将此秘钥分享给第三方，可实现快速对接。
    API key策略

  • IP鉴权： 允许某些IP地址访问，可用于有固定IP的用户/应用服务，如公网上部署的应用服务。
    IP鉴权策略

  • 平台用户： 平台用户可通过平台账户直接调用接口，一个用户只能创建一个策略。适用于已在平台注册的用户。

5.2 绑定API组

一个访问控制策略可以绑定多个API组，若同一个API组被绑定到多个访问策略，则按照认证类型的优先级 不鉴权(公开) > IP鉴权 > 平台用户 > API key 依次验证访问权限，直至拥有访问权限。

这里绑定刚设计的API组
绑定API组

第6章 测试API

以下介绍两种常见的测试API接口方式，用户根据自己习惯任选一种。
我们为您提供了两种常用的测试API接口的方法，您可以根据自己的喜好选择其中一种。

6.1 平台自带的接口调试工具

使用APISQL云平台自带API接口调试工具，特点是简单，支持设计API时所用的参数。
在单个API接口的 概览 界面，点击 运行。

  • 点击 搜索，查看该API支持的所有请求参数，示例值：填写一个测试的参数。

  • 点击 【运行】 查看执行结果的JSON和HTTP信息
    请求参数

  • 点击 认证信息， 切换认证方式，不鉴权(公开)、IP鉴权无须填写；API key、平台用户及密码认证需填写对应信息；

  • 点击 【查看HTTP信息】 可以查看HTTP的参数信息
    切换认证

  • 最常用的 API key认证 秘钥，是在【访问控制】->【创建访问控制策略】->【复制】获取，不要忘记 绑定API组，这个API组才能使用该秘钥访问。
    私钥位置

IP鉴权如下，使用是当前上网的IP地址，当前上网的IP可通过如www.ipip.net查看。
IP鉴权认证

6.2 第三方接口调试工具

这里使用一个替代Postman的开源接口调试工具： https://hoppscotch.io ，初次打开网站，
设置 -> 选择 语言 和 启用 代理中间件发送请求
hoppscotch设置

出于安全优先的原则，APISQL默认所有请求都是POST以请求，以HTTPS加密，HTTP2传输，所以我们这里选择POST。
POST

请求的**【参数】** 是以json格式放在 请求体 中，如下：

{
    "params": {"id": 1}
}

请求体

API key认证 秘钥在【访问控制】->【创建访问控制策略】->【复制】获取。

复制秘钥

然后将API Key放 【请求头】 中，注意有Bearer前辍后面还有个空格，（这是一种常见的认证方式，表示您使用的是API key，空格是为了区分前辍和秘钥）格式如下。

"Authorization": "Bearer sk-e225739e757138943774899fcdd1acda"

请求头

在没有配置API Key就发送，会收到类似“BAD_TOKEN”的提示，如下图所示，
所以在调试时可以跟据对应的错误提示，知道是哪方面的问题，再进行对应配置即可。
未填写请求头报错

对于API接口管理，文档是少不了，方便以后一目了然的知道接口干什么的。
API文档

文档是以Markdown方式保存至平台（Markdown是一种轻量级的标记语言，可以方便地编写和格式化文本，支持标题、列表、表格、代码块等多种元素），方便同事一起查阅和修改。
API文档以Markdown方式编辑

到此，您应该已经掌握了如何使用APISQL云平台主要功能，来快速设计和管理您的API接口。希望这些能够帮助您提高开发效率和质量。如果您有任何疑问或建议，欢迎随时联系我们，感谢您的支持。

完结散花！
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_42465759/article/details/135367692

智能推荐

redis6.2 使用 TLS 的部署(三种高可用模式)_redis 6.2版本启用tls认证-程序员宅基地

文章浏览阅读3.5k次。redis6.2 使用 TLS 的部署"三种高可用模式"安装redis6.2 并启用TLS加密安装创建TLS证书编写配置文件systemd管理测试连接redis 主从 配置 tls安装拷贝master 证书 到 slave编写配置文件systemd管理验证主从服务sentinel 哨兵服务创建目录、配置文件systemd管理查看sentinel 状态redis cluster 分片集群TLS安装规划目录及证书编写配置文件创建cluster 集群验证cluster 集群安装redis6.2 并启用TLS加密_redis 6.2版本启用tls认证

Sentinel-2波段合成_sentinel2 数据波段合成-程序员宅基地

文章浏览阅读378次。在上一篇博客中下载了Sentinel-2数据，他有13个波段的.jp2文件，下面选取需要使用的波段进行合成。导入了B2（蓝色）、B3（绿色）、B4（红色）、B8（近红外），直接存为TIFF会丢失坐标信息。最后将合成好的影像存为TIFF。得到下面这些.dat格式。_sentinel2 数据波段合成

【图像融合】基于错误纹理消除和显著特征检测的多模态脑图像融合神经科学前沿2023文献matlab复现-程序员宅基地

文章浏览阅读516次，点赞7次，收藏10次。多模态脑影像融合旨在将来自不同成像方式的脑影像数据进行融合，以获得更全面的信息。然而，由于不同成像方式的图像特性差异较大，直接融合会导致误差纹理和显著特征丢失等问题。本文提出了一种基于误差纹理消除和显著特征检测的多模态脑影像融合方法。该方法首先通过误差纹理消除算法去除融合图像中的误差纹理，然后通过显著特征检测算法提取融合图像中的显著特征，最后将显著特征融合到误差纹理消除后的图像中，得到最终的融合图像。实验结果表明，该方法可以有效消除误差纹理，保留显著特征，获得高质量的融合图像。引言。

python bar3d color_三维散点图colorbar matplotlib Python-程序员宅基地

文章浏览阅读1k次。我无法将颜色条添加到我的三维散点图中，它的颜色范围是根据bifurWidth的值在min和{}之间。我尝试过stackoverflow上显示的各种尝试，但都没有成功。任何帮助都将是非常感谢，因为我在这方面是一个重大的损失。在我最近的一次尝试是从下面的代码中散列出来的。在我的代码：from glob import globfrom pylab import *import numpy as npfr..._bar3d 好看的颜色

7.CSS-交集选择器、并集选择器、兄弟选择器_交集选择器和并集选择器使用方式-程序员宅基地

文章浏览阅读1.7k次。文章目录*交集选择器作用格式注意点并集选择器作用格式注意点相邻兄弟选择器作用格式注意点通用兄弟选择器作用格式注意点*交集选择器作用给所有选择器选中的标签中，相交的那部分设置属性。格式选择器1 选择器2{ 属性：值；}注意点1.选择器和选择器之间没有任何连接符号；2.选择器可以使用标签名称/id名称/class名称；3.仅了解。并集选择器作用给所有选择器选中的标签设置属性。格式选择器1，选择器2{属性：值；}注意点1.并集选择器必须使用，来连接；2.选择器可以使用_交集选择器和并集选择器使用方式

Windows CMD命令大全-程序员宅基地

文章浏览阅读79次。打开cmd快捷键 window键+RCMD命令锦集 1. gpedit.msc-----组策略　　2. sndrec32-------录音机　　3. Nslookup-------IP地址侦测器 ，是一个 监测网络中 DNS 服务器是否能正确实现域名解析的命令行工具。 它在 Windows NT/2000/XP 中均可使用 , 但在 Wi...

随便推点

计算机图形图像处理在教学中的应用,计算机图形图像处理案例教学法运用-程序员宅基地

文章浏览阅读534次。摘要：笔者根据计算机图形图像处理课程与中职学生学习的特点，分析了目前中职学校计算图形图像处理课程教学中存在的问题，针对如何提高中职学生对计算机图形图像处理课程的学习兴趣和解决实际问题的能力，提出了案例教学法在该课程中的具体实施办法，并对其实践进行了进一步的讨论。关键词：计算机图形图像处理；案例教学；中职当今世界电子商务发展迅速，计算机平面设计这门技术在很多领域都得到广泛应用。《Photoshop图..._图像分类在教育中的应用

python资源文件嵌入exe_pyinstaller将资源文件打包进exe中-程序员宅基地

文章浏览阅读921次。在网上看了很多博客，终于找到了符合自己智商可理解的打包资源文件方法，现引用如下https://www.cnblogs.com/darcymei/p/9397173.htmlhttps://blog.csdn.net/sinat_27382047/article/details/81304065"""终于把资源文件加载进去了，就是当exe文件移植后，它运行的时候会产生一个临时文件夹，把资源文件存储到..._pyinstaller如何将_internal添加进exe

H3C模拟器配置vlan-程序员宅基地

文章浏览阅读3.3k次，点赞4次，收藏7次。Valn 11组网需求• 交换机GE_2上的VLAN 5 和VLAN 10 为Primary VLAN，其上层端口GigabitEthernet1/0/1需要允许VLAN 5 和VLAN 10 的报文携带VLAN Tag 通过。• 交换机GE_2 的下行端口GigabitEthernet1/0/2 允许Secondary VLAN 2 通过，GigabitEthernet1/0/3 允许Sec..._新华3模拟器vlan配置

img撑满全屏的方法（img非背景图）_img 铺满-程序员宅基地

文章浏览阅读4.7w次，点赞8次，收藏15次。我有一个模板，想按常规做一个div里面放置一个img图片，并且让图片铺满容器，自适应容器大小。HTML结构代码如下（在这个盒模型上，我已经放置了一些不重要的样式）。div style="height:270px;width:400px;border:2px black solid;"> a href="http://www.paipk.com">img src="..." alt="拍_img 铺满

UnicodeDecodeError: ‘utf-8‘ codec can‘t decode byte 0xb0 in position 5: invalid start byte_ebpf bcc unicodedecodeerror: 'utf-8' codec can't d-程序员宅基地

文章浏览阅读947次。UnicodeDecodeError: 'gbk' codec can't decode byte 0xfa in position 4669: illegal multibyte sequenceUnicodeDecodeError: 'utf-8' codec can't decode byte 0xb0 in position 5: invalid start bytewith open('进线汇总20201211.csv',encoding='utf8') as f: t = f._ebpf bcc unicodedecodeerror: 'utf-8' codec can't decode byte 0xb0 in positio

使用条件序列GAN改进NMT_improving neural machine translation with conditio-程序员宅基地

文章浏览阅读1.3k次。使用条件序列GAN改进NMT原文《Improving Neural Machine Translation with Conditional Sequence Generative Adversarial Nets》课程作业，因为要导出pdf所以粘贴到CSDN了，34章是笔者翻译的部分。当一篇post吧，求别喷，有问题请留言我一定改，一定改。摘要本文提出了一种将GANs应用于NMT领域的方..._improving neural machine translation with conditional sequence generative ad

推荐文章

热门文章

相关标签