在postman中调试supabase的API接口

在supabase中获取API地址和key

首先登录dashboard后台,首页- 右上角点击 connect,获取前文创建的项目地址(API地址)和key备用。

image-20240701154424109

无需额外任何配置了。

知道它的restfull风格

比如我们创建了users数据库表,那么怎么通过API接口来访问呢?

只需要记住这个规则即可:

你的supabase项目地址/rest/v1/数据库表名
# 示例
https://llpowlcqtsvzzpugbhnh.supabase.co/rest/v1/users

因为它是标准的restfull风格,所以请求方式也是标准的CRUD操作,即getpostpatchdelete.

在postman中进行的设置

以下以上午建立的users表的 增删改查为例。它的API地址为:

https://llpowlcqtsvzzpugbhnh.supabase.co/rest/v1/users

API key则需要添加到headers请求头中或在url中体现。

https://<PROJECT_REF>.supabase.co/rest/v1/users?apikey=<ANON_KEY>

注意:所有的API接口请求都需要传输api key,比如添加到API的请求头中(headers)。

1、get请求调试

打开postman,新建一个request,粘贴刚刚的API接口地址。在headers中添加API key,如下图:

image-20240626172551789

如果一切正常,则会返回列表数据。

2、post新增用户调试

image-20240626173411486

post是使用raw-JSON格式来传给后台的,只需要传递必要的数据,比如uidcreated_at等则不需要显式传递。

在插入数据库时会自动新增。

image-20240626173608829

再来通过get接口查询,你会发现已经成功添加了一条数据。

如果我再插入一条username‘tom’的数据则会报错。

{
    "code": "23505",
    "details": "Key (username)=(tom) already exists.",
    "hint": null,
    "message": "duplicate key value violates unique constraint \"users_username_key\""
}

这是因为虽然我们没有写任何后端代码,但是在插入新数据时,它会自动根据数据库表设计时设置的unique等限制进行判断。

3、使用patch更新数据,不用put!

比如我要更新users表id为2124b03a-d561-4914-84fd-8097b794309a的数据需要使用patch,而不是put

https://llpowlcqtsvzzpugbhnh.supabase.co/rest/v1/users?id=eq.2124b03a-d561-4914-84fd-8097b794309a

入参即为要更新的json数据:

{
    "username": "new uname"
}

我最开始时是用put的,结果接口报错:

column pgrst_body.id does not exist

原因如下:

PATCH: 用于部分更新,只需发送要更新的字段。
PUT: 用于完全替换,必须发送完整的资源表示。

4、delete删除数据

比如我要更新users表id为2124b03a-d561-4914-84fd-8097b794309a的数据需要使用delete即可。

https://llpowlcqtsvzzpugbhnh.supabase.co/rest/v1/users?id=eq.2124b03a-d561-4914-84fd-8097b794309a

直接运行该接口即可删除指定的数据。

以上已经完成了某个API接口的增删改查。

总结

1、在使用接口联调时,确保每个API都需要附带请求头api key(类似于token

2、在update更新数据时,要使用patch而不是put

3、官方没看到有postman的调试说明。如果在vue等项目中联调,则需要使用官方的SDK工具库:@supabase/supabase-js库来完成。REST API手册:https://supabase.com/docs/guides/api

如果你在web前端开发、面试、前端学习路线有困难可以在下方加我名片。免费答疑,行业深潜多年的技术牛人帮你解决bug。

我可提供web前端开发,网站开发、技术咨询、答疑、直播讲座等服务

祝你能成为一名优秀的WEB前端开发工程师!

### 如何在本地环境中使用Postman进行API调试 #### 准备工作 为了能够在本地环境利用Postman进行有效的API调试,需先完成Postman软件的安装。这一步骤简单明了,按照官方指南操作即可[^1]。 #### 创建新的请求 启动Postman之后,在界面中选择创建一个新的Request。此时可以命名这个请求以便于识别它所对应的特定功能或目的。 #### 配置请求详情 对于需要调试API接口来说,如果是以POST方式进行数据交互,则应在Postman内指定此请求类型为`POST`。接着输入目标URL——即指向本地服务器上运行的服务端点地址。假设是在localhost环境下测试,那么可能是形如`http://localhost:3000/api/endpoint`这样的路径[^4]。 ```json { "url": "http://localhost:3000/api/endpoint", "method": "POST" } ``` #### 添加必要的头部信息 某些情况下,特别是当涉及到认证机制时,像Supabase这类服务可能要求提供额外的信息作为HTTP头的一部分来验证身份合法性。这时就需要向Headers标签页里加入相应的键值对,比如`Authorization`字段及其后的Bearer Token或者API Key等[^2]。 | Key | Value | |--------------|---------------------| | Authorization| Bearer YOUR_API_KEY | #### 设置主体内容 依据实际应用场景的不同,还需要考虑设置Body部分的内容形式(raw/json, form-data等形式),并将预期发送给服务器的数据填入其中。如果是JSON格式的话,记得勾选相应选项并填写合法的JSON字符串。 ```json { "sku": "example_sku_value" } ``` #### 发送请求与查看响应 配置完成后点击Send按钮发出请求,随后可以在下方区域看到返回的结果。这里不仅包含了状态码、消息体,还有详细的Header信息供开发者分析问题所在之处。 通过上述流程,便可在本地成功地借助Postman工具来进行API的功能性和性能上的调试工作。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值