Nuxt3 实战 (十):使用 Supabase 实现 RESTful 风格 API 接口

简介: 这篇文章介绍了如何使用Supabase实现RESTful风格的API接口,用于网站分类和子站点的增删改查(CURD)功能。文章首先阐述了表设计,包括ds_categorys和ds_websites两张表的列名、类型和用途,并提到了为每张表添加的user_id和email字段以支持用户身份识别。接着,文章描述了接口设计,以ds_websites表为例,说明了如何通过RESTful API实现CURD功能,并给出了使用SupabaseClient实现插入数据的相关代码。文章最后提供了项目效果预览和总结,指出学习了Nuxt3创建接口及调用Supabase数据库操作。

前言

本篇文章我们来使用 Supabase 实现 RESTful 风格的 API 接口,以此来实现网站分类和子站点的 CURD 功能。

表设计

这里需要用到两张表:

1、 ds_categorys:存储网站分类

列名 类型 备注
id uuid 主键,分类 id
name text 分类名称
desc text 分类描述
sort int2 排序

2、 ds_websites:存储网站分类子站点

列名 类型 备注
id uuid 主键,站点 id
name text 站点名称
desc text 站点描述
category_id uuid 所属分类 id
url text 站点 url
logo text 站点 logo
tags text 站点标签
sort int2 排序

这里需要注意的是,因为 Supabase 使用的是 postgresqlRow Level Security (RLS),一些数据库的操作对应不同的策略,这里我们还应该为每张表加上两个字段:

列名 类型 备注
user_id auth.uid() 登录用户的 uuid
email text 登录用户的 email

j67tl014dwcc2vx407m20sog2478u9e2.png

数据录入的时候 user_id 会自动填充,但是 email 需要在前台带入

接口设计

这里以 ds_websites 表为例,前台需要实现 CURD 功能,为此我们把接口设计成 RESTful 风格:

接口 Methods 备注
/api/websites Get 读取
/api/websites Post 新增
/api/websites Put 更新
/api/websites Delete 删除

前端实现

阅读 Nuxt3 中文文档,我们可以在 server/api 目录下新增接口。

  1. Get 接口server/api 目录下新建 index.get.ts 文件:

    import type {
          Response, PageResponse, WebsiteList, WebsiteParams } from '~/types'
    import {
          serverSupabaseClient } from '#supabase/server'
    import {
          RESPONSE_STATUS_CODE } from '~/enum'
    
    export default defineEventHandler(async (event): Promise<Response<PageResponse<WebsiteList>>> => {
         
    const client = await serverSupabaseClient(event)
    // 获取请求参数
    const {
          current, pageSize, name = '', category_id = '' } = getQuery(event) as WebsiteParams
    // 判断参数
    if (!current || !pageSize) {
         
      return {
          code: RESPONSE_STATUS_CODE.FAIL, msg: '参数错误' }
    }
    
    // 计算分页
    const start = (current - 1) * pageSize
    const end = current * pageSize - 1
    
    // 查询 sql
    let sqlQuery = client
      .from('ds_websites')
      .select('*,ds_categorys(*)', {
          count: 'exact' })
      .range(start, end)
      .order('sort', {
         
        ascending: false
      })
      .order('created_at', {
         
        ascending: false
      })
    
    // 判断查询参数
    if (name) {
         
      sqlQuery = sqlQuery.like('name', `%${
           name}%`)
    }
    if (category_id) {
         
      sqlQuery = sqlQuery.eq('category_id', category_id)
    }
    
    // 请求列表
    const {
          data, error, count } = await sqlQuery
    
    // 判断请求结果
    if (error) {
         
      throw createError({
         
        statusCode: RESPONSE_STATUS_CODE.FAIL,
        statusMessage: error.message
      })
    }
    
    // 请求成功
    return {
         
      code: RESPONSE_STATUS_CODE.SUCCESS,
      msg: '请求成功',
      data: {
         
        list: data,
        total: count
      }
    }
    })
    
  2. Post 接口server/api 目录下新建 index.post.ts 文件:

    import type {
          Response, WebsiteEdit, WebsiteList } from '~/types'
    import {
          serverSupabaseClient, serverSupabaseUser } from '#supabase/server'
    import {
          RESPONSE_STATUS_CODE } from '~/enum'
    
    export default defineEventHandler(async (event): Promise<Response<WebsiteList[]>> => {
         
    const client = await serverSupabaseClient<WebsiteList>(event)
    const user = await serverSupabaseUser(event)
    // 得到请求体
    const body: WebsiteEdit = await readBody(event)
    
    // 插入数据
    const {
          data, error } = await client
      .from('ds_websites')
      .insert({
          ...body, email: user?.email })
      .select()
    
    // 判断请求结果
    if (error) {
         
      // 23505 是 PostgreSQL 的唯一性违反错误码
      if (error.code === '23505') {
         
        return {
         
          code: RESPONSE_STATUS_CODE.FAIL,
          msg: '站点名称已存在!'
        }
      } else {
         
        throw createError({
         
          statusCode: RESPONSE_STATUS_CODE.FAIL,
          statusMessage: error.message
        })
      }
    }
    
    // 请求成功
    return {
         
      code: RESPONSE_STATUS_CODE.SUCCESS,
      msg: '请求成功',
      data: data
    }
    })
    
  3. Put 接口server/api 目录下新建 index.put.ts 文件:

    import type {
          Response, WebsiteEdit, WebsiteList } from '~/types'
    import {
          serverSupabaseClient } from '#supabase/server'
    import {
          RESPONSE_STATUS_CODE } from '~/enum'
    
    export default defineEventHandler(async (event): Promise<Response<WebsiteList[]>> => {
         
    const client = await serverSupabaseClient<WebsiteList>(event)
    // 得到请求体
    const {
          id, ...body }: WebsiteEdit = await readBody(event)
    
    if (!id) {
         
      return {
         
        code: RESPONSE_STATUS_CODE.FAIL,
        msg: 'id不能为空!'
      }
    }
    
    // 插入数据
    const {
          data, error } = await client
      .from('ds_websites')
      .update({
          ...body, updated_at: new Date() })
      .eq('id', id)
      .select()
    
    // 判断请求结果
    if (error) {
         
      // 23505 是 PostgreSQL 的唯一性违反错误码
      if (error.code === '23505') {
         
        return {
         
          code: RESPONSE_STATUS_CODE.FAIL,
          msg: '站点名称已存在!'
        }
      } else {
         
        throw createError({
         
          statusCode: RESPONSE_STATUS_CODE.FAIL,
          statusMessage: error.message
        })
      }
    }
    
    // 请求成功
    return {
         
      code: RESPONSE_STATUS_CODE.SUCCESS,
      msg: '请求成功',
      data: data
    }
    })
    
  4. Delete 接口server/api 目录下新建 index.delete.ts 文件:

    import type {
          Response, WebsiteEdit, WebsiteList } from '~/types'
    import {
          serverSupabaseClient } from '#supabase/server'
    import {
          RESPONSE_STATUS_CODE } from '~/enum'
    
    export default defineEventHandler(async (event): Promise<Response<WebsiteList[]>> => {
         
    const client = await serverSupabaseClient<WebsiteList>(event)
    // 得到请求体
    const {
          id }: WebsiteEdit = await readBody(event)
    
    if (!id) {
         
      return {
         
        code: RESPONSE_STATUS_CODE.FAIL,
        msg: 'id不能为空!'
      }
    }
    
    // 删除数据
    const {
          error } = await client.from('ds_websites').delete().eq('id', id)
    
    // 判断请求结果
    if (error) {
         
      throw createError({
         
        statusCode: RESPONSE_STATUS_CODE.FAIL,
        statusMessage: error.message
      })
    }
    
    // 请求成功
    return {
         
      code: RESPONSE_STATUS_CODE.SUCCESS,
      msg: '请求成功'
    }
    })
    
  5. 前端调用方式

    <script setup lang="ts">
    const {
           data } = await useFetch('/api/websites')
    </script>
    
    <template>
    <pre>{
        { data }}</pre>
    </template>
    

接口的相关逻辑,自己可以根据实际情况修改,具体的数据库操作文档可参考: Supabase API DOCS

效果预览

1stxxcrznta7g5l8xdiv0nco939kt81c.gif

总结

本篇文章我们学到了以下知识:

  1. Nuxt3 如何创建接口并调用
  2. Supabase 数据库的基本操作和表的创建

到这里,项目的整体框架就已经出来了,后续我们要做的就是添加数据和完善优化,并根据自己爱好添加一些自己喜欢的功能。

Github 仓库dream-site

线上预览dream-site.cn

相关文章
|
6天前
|
缓存 监控 前端开发
顺企网 API 开发实战:搜索 / 详情接口从 0 到 1 落地(附 Elasticsearch 优化 + 错误速查)
企业API开发常陷参数、缓存、错误处理三大坑?本指南拆解顺企网双接口全流程,涵盖搜索优化、签名验证、限流应对,附可复用代码与错误速查表,助你2小时高效搞定开发,提升响应速度与稳定性。
|
7天前
|
缓存 自然语言处理 API
阿里巴巴国际站关键字搜索 API 实战:3 步搞定多语言适配 + 限流破局,询盘量提升 40%
跨境电商API开发常陷合规、多语言、限流等坑。本文详解从国际合规(GDPR/CCPA)到参数优化、数据结构化及区域化搜索的全链路方案,附Python代码模板与缓存重试架构,助力提升调用成功率至99%+,精准询盘增长42%。
|
26天前
|
Cloud Native 算法 API
Python API接口实战指南:从入门到精通
🌟蒋星熠Jaxonic,技术宇宙的星际旅人。深耕API开发,以Python为舟,探索RESTful、GraphQL等接口奥秘。擅长requests、aiohttp实战,专注性能优化与架构设计,用代码连接万物,谱写极客诗篇。
Python API接口实战指南:从入门到精通
|
10天前
|
JSON 算法 API
Python采集淘宝商品评论API接口及JSON数据返回全程指南
Python采集淘宝商品评论API接口及JSON数据返回全程指南
|
19天前
|
JSON API 数据安全/隐私保护
Python采集淘宝拍立淘按图搜索API接口及JSON数据返回全流程指南
通过以上流程,可实现淘宝拍立淘按图搜索的完整调用链路,并获取结构化的JSON商品数据,支撑电商比价、智能推荐等业务场景。
|
17天前
|
开发者 API 机器学习/深度学习
淘宝 / 1688 / 义乌购图搜 API 实战指南:接口调用与商业场景应用
本文详解淘宝、1688、义乌购三大平台图片搜索接口的核心特点、调用流程与实战代码。涵盖跨平台对比、参数配置、响应解析及避坑指南,支持URL/Base64上传,返回商品ID、价格、销量等关键信息,助力开发者快速实现商品识别与比价功能。
淘宝 / 1688 / 义乌购图搜 API 实战指南:接口调用与商业场景应用
|
28天前
|
JSON 前端开发 API
如何调用体育数据足篮接口API
本文介绍如何调用体育数据API:首先选择可靠服务商并注册获取密钥,接着阅读文档了解基础URL、端点、参数及请求头,然后使用Python等语言发送请求、解析JSON数据,最后将数据应用于Web、App或分析场景,同时注意密钥安全、速率限制与错误处理。
|
10天前
|
存储 缓存 算法
亚马逊 SP-API 深度开发:关键字搜索接口的购物意图挖掘与合规竞品分析
本文深度解析亚马逊SP-API关键字搜索接口的合规调用与商业应用,涵盖意图识别、竞品分析、性能优化全链路。通过COSMO算法解析用户购物意图,结合合规技术方案提升关键词转化率,助力卖家实现数据驱动决策,安全高效优化运营。
|
27天前
|
人工智能 运维 监控
阿里云 API 聚合实战:破解接口碎片化难题,3 类场景方案让业务响应提速 60%
API聚合破解接口碎片化困局,助力开发者降本增效。通过统一中间层整合微服务、第三方接口与AI模型,实现调用次数减少60%、响应提速70%。阿里云实测:APISIX+函数计算+ARMS监控组合,支撑百万级并发,故障定位效率提升90%。
191 0
|
28天前
|
JSON 自然语言处理 监控
淘宝关键词搜索与商品详情API接口(JSON数据返回)
通过商品ID(num_iid)获取商品全量信息,包括SKU规格、库存、促销活动、卖家信息、详情页HTML等。