在设计API URL时,我们可以使用查询参数或路径参数来传递参数。具体使用哪种方式取决于具体的需求和设计约定。
查询参数是以键值对的形式出现在URL的查询字符串中(即在URL中以问号?开头的部分)。它们是用来过滤、排序和限制结果的常见方式。
路径参数是出现在URL路径中的一部分。它们通常用于标识资源或指定操作。
下面是一个包含代码示例的解决方案,演示了如何使用查询参数和路径参数。
查询参数示例:
GET /api/users?name=john&age=25
路径参数示例:
GET /api/users/{id}
代码示例:
from flask import Flask, request
app = Flask(__name__)
@app.route('/api/users', methods=['GET'])
def get_users():
name = request.args.get('name') # 使用查询参数获取name参数
age = request.args.get('age') # 使用查询参数获取age参数
# 执行根据查询参数过滤用户的逻辑
return 'Get users'
@app.route('/api/users/', methods=['GET'])
def get_user(id):
# 执行根据路径参数获取指定用户的逻辑
return f'Get user {id}'
if __name__ == '__main__':
app.run()
在上述示例中,get_users
函数使用查询参数来过滤用户,而get_user
函数使用路径参数来获取指定的用户。你可以根据自己的需求选择使用查询参数还是路径参数,或者同时使用它们。