Next 编写接口api

简介: Next 编写接口api

Next.js 14(以及自Next.js 13开始)引入了app目录和新的路由方式,包括API路由的编写方式也发生了一些变化。虽然pages目录仍然受支持,但app目录提供了一种更现代化的方式来处理路由和API。

编写api接口文件

app目录中 ,每个子目录对应一个路由,route.js文件用于处理API请求,而页面组件文件(通常为page.jspage.tsx)用于处理页面渲染。  

例如创建两个接口,需要在 app 目录下api创建文件夹(访问接口名) 下场景 route.ts 即可

app/
├── api/
│   ├── hello/
│   │   └── route.js     # 对应路径 /api/hello
│   └── submit/
│       └── route.js     # 对应路径 /api/submit

对应访问:

  • http://localhost:3000/api/hello
  • http://localhost:3000/api/submit

复杂

页面+API 文件结构

如果想 同时处理前端页面的渲染和后端API  ,结果如下:

app/
├── api/
│   ├── hello/
│   │   └── route.js         # 对应路径 /api/hello
│   ├── submit/
│   │   └── route.js         # 对应路径 /api/submit
│   └── users/
│       └── route.js         # 对应路径 /api/users
├── page.js                   # 根路径的页面文件,对应路径 /
├── about/
│   └── page.js               # 关于页面的文件,对应路径 /about
├── users/
│   ├── page.js               # 用户页面的文件,对应路径 /users
│   └── [id]/
│       └── page.js           # 动态路由页面文件,对应路径 /users/[id]

完整 CURD  API 编写

文件结构

app/
├── api/
│   ├── users/
│   │   ├── route.js       # 处理GET、POST请求
│   │   └── [id]/
│   │       └── route.js   # 处理单个用户的GET、PUT、DELETE请求
├── users/
│   ├── page.js            # 用户列表页面,展示所有用户
│   └── [id]/
│       └── page.js        # 用户详情页面,展示单个用户信息
├── page.js                # 根路径的页面文件
└── layout.js              # 布局文件

API 路由

下面是使用的Mogodb 数据库,这块可以自己业务选型数据库使用

GET POST 请求

app/
├── api/
│   ├── users/
│   │   ├── route.js       # 处理GET、POST请求
// app/api/users/route.js
import clientPromise from '@/lib/mongodb';
import { NextResponse } from 'next/server';
// 处理GET请求,返回所有用户
export async function GET() {
  const client = await clientPromise;
  const db = client.db('mydatabase');
  const users = await db.collection('users').find({}).toArray();
  return NextResponse.json(users);
}
// 处理POST请求,创建新用户
export async function POST(request) {
  const client = await clientPromise;
  const db = client.db('mydatabase');
  const data = await request.json();
  // 验证输入数据
  if (!data.name || !data.email) {
    return NextResponse.json({ message: 'Name and Email are required' }, { status: 400 });
  }
  // 插入新用户
  const result = await db.collection('users').insertOne(data);
  return NextResponse.json(result.ops[0], { status: 201 });
}

动态api  [获取详情, 更新数据, 删除数据]

app/
├── api/
│   ├── users/
│   │   ├── route.js       # 处理GET、POST请求
│   │   └── [id]/
│   │       └── route.js   # 处理单个用户的GET、PUT、DELETE请求

通过定义动态文件 app/api/users/[id]/route.js

分别定义3个方法来处理对应请求业务

  • GET: 获取详情
  • PUT: 更新数据
  • DELETE: 删除数据
// app/api/users/[id]/route.js
import clientPromise from '@/lib/mongodb';
import { ObjectId } from 'mongodb';
import { NextResponse } from 'next/server';
// 处理GET请求,获取单个用户的信息
export async function GET(request, { params }) {
  const client = await clientPromise;
  const db = client.db('mydatabase');
  const user = await db.collection('users').findOne({ _id: new ObjectId(params.id) });
  if (!user) {
    return NextResponse.json({ message: 'User not found' }, { status: 404 });
  }
  return NextResponse.json(user);
}
// 处理PUT请求,更新用户的信息
export async function PUT(request, { params }) {
  const client = await clientPromise;
  const db = client.db('mydatabase');
  const data = await request.json();
  // 更新用户数据
  const result = await db.collection('users').updateOne(
    { _id: new ObjectId(params.id) },
    { $set: data }
  );
  if (result.matchedCount === 0) {
    return NextResponse.json({ message: 'User not found' }, { status: 404 });
  }
  const updatedUser = await db.collection('users').findOne({ _id: new ObjectId(params.id) });
  return NextResponse.json(updatedUser);
}
// 处理DELETE请求,删除用户
export async function DELETE(request, { params }) {
  const client = await clientPromise;
  const db = client.db('mydatabase');
  const result = await db.collection('users').deleteOne({ _id: new ObjectId(params.id) });
  if (result.deletedCount === 0) {
    return NextResponse.json({ message: 'User not found' }, { status: 404 });
  }
  return NextResponse.json({ message: 'User deleted successfully' });
}
相关文章
|
7天前
|
存储 运维 安全
云上金融量化策略回测方案与最佳实践
2024年11月29日,阿里云在上海举办金融量化策略回测Workshop,汇聚多位行业专家,围绕量化投资的最佳实践、数据隐私安全、量化策略回测方案等议题进行深入探讨。活动特别设计了动手实践环节,帮助参会者亲身体验阿里云产品功能,涵盖EHPC量化回测和Argo Workflows量化回测两大主题,旨在提升量化投研效率与安全性。
云上金融量化策略回测方案与最佳实践
|
9天前
|
人工智能 自然语言处理 前端开发
从0开始打造一款APP:前端+搭建本机服务,定制暖冬卫衣先到先得
通义灵码携手科技博主@玺哥超carry 打造全网第一个完整的、面向普通人的自然语言编程教程。完全使用 AI,再配合简单易懂的方法,只要你会打字,就能真正做出一个完整的应用。
8439 20
|
13天前
|
Cloud Native Apache 流计算
资料合集|Flink Forward Asia 2024 上海站
Apache Flink 年度技术盛会聚焦“回顾过去,展望未来”,涵盖流式湖仓、流批一体、Data+AI 等八大核心议题,近百家厂商参与,深入探讨前沿技术发展。小松鼠为大家整理了 FFA 2024 演讲 PPT ,可在线阅读和下载。
4556 11
资料合集|Flink Forward Asia 2024 上海站
|
13天前
|
自然语言处理 数据可视化 API
Qwen系列模型+GraphRAG/LightRAG/Kotaemon从0开始构建中医方剂大模型知识图谱问答
本文详细记录了作者在短时间内尝试构建中医药知识图谱的过程,涵盖了GraphRAG、LightRAG和Kotaemon三种图RAG架构的对比与应用。通过实际操作,作者不仅展示了如何利用这些工具构建知识图谱,还指出了每种工具的优势和局限性。尽管初步构建的知识图谱在数据处理、实体识别和关系抽取等方面存在不足,但为后续的优化和改进提供了宝贵的经验和方向。此外,文章强调了知识图谱构建不仅仅是技术问题,还需要深入整合领域知识和满足用户需求,体现了跨学科合作的重要性。
|
21天前
|
人工智能 自动驾驶 大数据
预告 | 阿里云邀您参加2024中国生成式AI大会上海站,马上报名
大会以“智能跃进 创造无限”为主题,设置主会场峰会、分会场研讨会及展览区,聚焦大模型、AI Infra等热点议题。阿里云智算集群产品解决方案负责人丛培岩将出席并发表《高性能智算集群设计思考与实践》主题演讲。观众报名现已开放。
|
9天前
|
人工智能 容器
三句话开发一个刮刮乐小游戏!暖ta一整个冬天!
本文介绍了如何利用千问开发一款情侣刮刮乐小游戏,通过三步简单指令实现从单个功能到整体框架,再到多端优化的过程,旨在为生活增添乐趣,促进情感交流。在线体验地址已提供,鼓励读者动手尝试,探索编程与AI结合的无限可能。
三句话开发一个刮刮乐小游戏!暖ta一整个冬天!
|
1月前
|
存储 人工智能 弹性计算
阿里云弹性计算_加速计算专场精华概览 | 2024云栖大会回顾
2024年9月19-21日,2024云栖大会在杭州云栖小镇举行,阿里云智能集团资深技术专家、异构计算产品技术负责人王超等多位产品、技术专家,共同带来了题为《AI Infra的前沿技术与应用实践》的专场session。本次专场重点介绍了阿里云AI Infra 产品架构与技术能力,及用户如何使用阿里云灵骏产品进行AI大模型开发、训练和应用。围绕当下大模型训练和推理的技术难点,专家们分享了如何在阿里云上实现稳定、高效、经济的大模型训练,并通过多个客户案例展示了云上大模型训练的显著优势。
104586 10
|
8天前
|
消息中间件 人工智能 运维
12月更文特别场——寻找用云高手,分享云&AI实践
我们寻找你,用云高手,欢迎分享你的真知灼见!
719 44
|
6天前
|
弹性计算 运维 监控
阿里云云服务诊断工具:合作伙伴架构师的深度洞察与优化建议
作为阿里云的合作伙伴架构师,我深入体验了其云服务诊断工具,该工具通过实时监控与历史趋势分析,自动化检查并提供详细的诊断报告,极大提升了运维效率和系统稳定性,特别在处理ECS实例资源不可用等问题时表现突出。此外,它支持预防性维护,帮助识别潜在问题,减少业务中断。尽管如此,仍建议增强诊断效能、扩大云产品覆盖范围、提供自定义诊断选项、加强教育与培训资源、集成第三方工具,以进一步提升用户体验。
639 243
|
3天前
|
弹性计算 运维 监控
云服务测评 | 基于云服务诊断全方位监管云产品
本文介绍了阿里云的云服务诊断功能,包括健康状态和诊断两大核心功能。作者通过个人账号体验了该服务,指出其在监控云资源状态和快速排查异常方面的优势,同时也提出了一些改进建议,如增加告警配置入口和扩大诊断范围等。