API 查询 参数是附加到 API 请求 URL 的键值对,用于向服务器发送附加信息。它们允许客户端(例如 Web 浏览器或应用程序)在向服务器发出请求时指定某些条件或传递数据。
查询参数添加到 URL 末尾问号 (?) 后。每个参数都是一个键值对,键和值之间用等号 (=) 分隔。如果有多个查询参数,则用“&”分隔。
查询参数如何使用:
过滤数据:客户端可以使用查询参数来过滤他们想要的数据。例如, ?category=books 可能会告诉服务器仅返回“书籍”类别中的项目。
分页:查询参数通常用于 API 请求中的分页,允许客户端指定要获取哪一页结果以及每页有多少个项目。示例:?page=2&limit=10.
排序和顺序:查询参数可用于指定数据应如何排序。例如,?sort=price&order=asc 可以指示服务器返回按价格升序排序的项目。
传递搜索词:API 通常使用查询参数来允许客户端搜索数据。例如,?search=laptop 可用于查找与术语“laptop”匹配的所有产品。
查询参数非常灵活,可以通过多种方式使用,具体取决于 API 的设计方式。它们允许客户端和服务器之间进行动态交互,从而更容易请求定制数据。
// pages/api/greet.js export default function handler(req, res) { const { name } = req.query; // Get the 'name' query parameter const greeting = name ? `Hello, ${name}!` : 'Hello, stranger!'; res.status(200).json({ message: greeting }); }
用法示例:
/api/greet?name=John 将返回 { "message": "你好,约翰!" }
/api/greet 将返回 { "message": "你好,陌生人!" }
// pages/api/user.js export default function handler(req, res) { const { name, age } = req.query; // Get 'name' and 'age' query parameters if (!name || !age) { res.status(400).json({ error: 'Name and age are required' }); return; } res.status(200).json({ message: `User ${name} is ${age} years old.` }); }
用法示例:
/api/user?name=Jane&age=28 将返回 { "message": "用户 Jane 28 岁。" }
/api/user?name=Jane 将返回 { "error": "姓名和年龄为必填项" }
// pages/api/score.js export default function handler(req, res) { const { player = 'Anonymous', score = '0' } = req.query; // Default values if missing res.status(200).json({ message: `${player} scored ${score} points!` }); }
用法示例:
/api/score?player=Alex&score=100 将返回 { "message": "Alex 得分 100 分!" }
/api/score 将返回 { "message": "匿名者得分为 0 分!" }
// pages/api/tags.js export default function handler(req, res) { const { tags } = req.query; // Get 'tags' query parameter (array) if (!tags) { res.status(400).json({ error: 'Tags are required' }); return; } res.status(200).json({ message: `You have selected these tags: ${tags.join(', ')}` }); }
用法示例:
/api/tags?tags=javascript&tags=react 将返回 { "message": "您已选择这些标签:javascript、react" }
/api/tags 将返回 { "error": "Tags are required" }
// pages/api/items.js export default function handler(req, res) { const { page = 1, limit = 10 } = req.query; // Default values for page and limit const startIndex = (page - 1) * limit; const endIndex = startIndex Number(limit); // Dummy data for demonstration const items = Array.from({ length: 100 }, (_, i) => `Item ${i 1}`); const paginatedItems = items.slice(startIndex, endIndex); res.status(200).json({ currentPage: page, perPage: limit, items: paginatedItems, }); }
用法示例:
/api/items?page=2&limit=5 将返回接下来的 5 个项目,例如 { "items": ["Item 6", "Item 7", "Item 8", "Item 9", "Item 10"] }
/api/items(默认值)将返回前 10 个项目,例如 { "items": ["Item 1", "Item 2", ..., "Item 10"] }
这些示例演示了在 Next.js API 路由中使用查询参数的灵活性,涵盖单个或多个参数、可选值、数组和分页等常见模式。
免责声明: 提供的所有资源部分来自互联网,如果有侵犯您的版权或其他权益,请说明详细缘由并提供版权或权益证明然后发到邮箱:[email protected] 我们会第一时间内为您处理。
Copyright© 2022 湘ICP备2022001581号-3