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' });
}
相关文章
|
2月前
|
JSON API 数据格式
淘宝/天猫图片搜索API接口,json返回数据。
淘宝/天猫平台虽未开放直接的图片搜索API,但可通过阿里妈妈淘宝联盟或天猫开放平台接口实现类似功能。本文提供基于淘宝联盟的图片关联商品搜索Curl示例及JSON响应说明,适用于已获权限的开发者。如需更高精度搜索,可选用阿里云视觉智能API。
|
2月前
|
JSON API 数据安全/隐私保护
深度分析淘宝卖家订单详情API接口,用json返回数据
淘宝卖家订单详情API(taobao.trade.fullinfo.get)是淘宝开放平台提供的重要接口,用于获取单个订单的完整信息,包括订单状态、买家信息、商品明细、支付与物流信息等,支撑订单管理、ERP对接及售后处理。需通过appkey、appsecret和session认证,并遵守调用频率与数据权限限制。本文详解其使用方法并附Python调用示例。
|
16天前
|
数据可视化 测试技术 API
从接口性能到稳定性:这些API调试工具,让你的开发过程事半功倍
在软件开发中,接口调试与测试对接口性能、稳定性、准确性及团队协作至关重要。随着开发节奏加快,传统方式已难满足需求,专业API工具成为首选。本文介绍了Apifox、Postman、YApi、SoapUI、JMeter、Swagger等主流工具,对比其功能与适用场景,并推荐Apifox作为集成度高、支持中文、可视化强的一体化解决方案,助力提升API开发与测试效率。
|
2月前
|
监控 算法 API
电商API接口对接实录:淘宝优惠券接口对接处理促销监控系统
在电商开发中,淘宝详情页的“券后价计算”是极易出错的环节。本文作者结合实战经验,分享了因忽略满减券门槛、有效期、适用范围等导致的踩坑经历,并提供了完整的解决方案,包括淘宝API签名生成、券后价计算逻辑、常见坑点及优化建议,助力开发者精准实现券后价功能,避免业务损失。
|
2月前
|
JSON 算法 安全
淘宝商品详情API接口系列,json数据返回
淘宝开放平台提供了多种API接口用于获取商品详情信息,主要通过 淘宝开放平台(Taobao Open Platform, TOP) 的 taobao.tbk.item.info.get(淘宝客商品详情)或 taobao.item.get(标准商品API)等接口实现。以下是关键信息及JSON返回示例:
|
2月前
|
设计模式 JSON Unix
微店商品详情API接口,json数据返回
微店商品详情API接口的典型JSON返回数据结构说明,基于公开的微店开放平台API文档和常见电商API设计模式整理。实际使用时请以微店官方最新文档为准
|
4天前
|
JSON 前端开发 API
如何调用体育数据足篮接口API
本文介绍如何调用体育数据API:首先选择可靠服务商并注册获取密钥,接着阅读文档了解基础URL、端点、参数及请求头,然后使用Python等语言发送请求、解析JSON数据,最后将数据应用于Web、App或分析场景,同时注意密钥安全、速率限制与错误处理。
|
14天前
|
JSON API 数据安全/隐私保护
Python采集淘宝评论API接口及JSON数据返回全流程指南
Python采集淘宝评论API接口及JSON数据返回全流程指南
|
22天前
|
JSON 供应链 监控
1688商品详情API技术深度解析:从接口架构到数据融合实战
1688商品详情API(item_get接口)可通过商品ID获取标题、价格、库存、SKU等核心数据,适用于价格监控、供应链管理等场景。支持JSON格式返回,需企业认证。Python示例展示如何调用接口获取商品信息。
|
4天前
|
JSON 自然语言处理 监控
淘宝关键词搜索与商品详情API接口(JSON数据返回)
通过商品ID(num_iid)获取商品全量信息,包括SKU规格、库存、促销活动、卖家信息、详情页HTML等。