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

相关文章
|
4天前
|
JSON Java API
如何设计可扩展的RESTful API?
如何设计可扩展的RESTful API?
|
8天前
|
NoSQL 安全 API
如何有效提升 API 接口的安全性?
**API安全关键在于验证和防刷。通过排序参数、生成签名和MD5加密确保请求合法性。使用Redis限制请求频率,防止接口被恶意刷取。验证和防刷策略结合,保护API免受攻击和滥用。**
28 0
|
5天前
|
JSON Java API
如何设计可扩展的RESTful API?
如何设计可扩展的RESTful API?
|
9天前
|
XML Java API
使用Java构建RESTful API的最佳实践
使用Java构建RESTful API的最佳实践
|
10天前
|
Java API PHP
【亲测有效,官方提供】php版本企查查api接口请求示例代码,php请求企查查api接口,thinkphp请求企查查api接口
【亲测有效,官方提供】php版本企查查api接口请求示例代码,php请求企查查api接口,thinkphp请求企查查api接口
17 1
|
4天前
|
存储 监控 API
解锁京东 APP 商品详情的 API 接口获取方法
在数字化商业环境中,获取京东APP商品详情的API接口至关重要。这有助于电商数据分析、价格监控、商品推荐等。API接口提供高效、稳定且合规的数据源,允许快速获取大量商品信息。要使用接口,需注册开发者账号、了解接口文档并进行开发调试。示例代码展示了Python如何调用接口。同时,注意遵守规则、处理数据安全及接口更新。利用API能提升业务效率,但需在合法合规下进行。
|
4天前
|
Java API 数据库
使用Spring Boot构建RESTful API
使用Spring Boot构建RESTful API
|
5天前
|
开发框架 Java API
使用Spring Boot构建RESTful API的最佳实践
使用Spring Boot构建RESTful API的最佳实践
|
7天前
|
JSON 数据格式
MysbatisPlus-核心功能-IService开发基础业务接口,MysbatisPlus_Restful风格,新增@RequestBody指定是为了接收Json数据的,使用swagger必须注解
MysbatisPlus-核心功能-IService开发基础业务接口,MysbatisPlus_Restful风格,新增@RequestBody指定是为了接收Json数据的,使用swagger必须注解
|
9天前
|
数据采集 自然语言处理 算法
淘宝评论的 API 接口获取:技术探索与应用
这篇文稿探讨了淘宝评论API在数据驱动的商业环境中的重要性。API接口使得高效、精准地获取淘宝评论成为可能,帮助企业分析消费者反馈、优化产品和服务,以及训练智能算法。通过API,商家能实时监控评论以快速响应市场变化,同时确保数据合规性和安全性。然而,获取和使用数据涉及复杂的接口调用、数据清洗、反爬虫机制应对等挑战。通过实际案例,展示了API如何促进产品优化、市场研究和智能客服改进。随着技术发展,未来将有更多创新应用,但也需面对更严格的法规监管。