首页手记 RESTful接口资料：新手入门教程

RESTful接口资料：新手入门教程

标签：

接口测试 API

概述

RESTful接口是一种高效的设计网络应用程序的架构风格，通过标准的HTTP方法操作资源，使得应用程序更加易于理解和使用。本文详细介绍了RESTful接口的基本特点、示例代码、资源与资源标识的设计、HTTP方法的应用，以及认证与安全的实现方法。文中还提供了如何使用Postman和curl命令对RESTful接口进行测试的方法。提供了丰富的RESTful接口资料，涵盖从基本概念到高级应用的各个方面。

RESTful接口简介

REST（Representational State Transfer）是一种软件架构风格，用于设计网络应用程序，特别是那些使用HTTP协议的应用程序。它通过使用标准的HTTP方法（如GET、POST、PUT、DELETE）来操作资源，使得应用程序更加易于理解和使用。

REST和RESTful的概念

REST是一种架构风格，它规定了一组约束条件和设计原则，使得分布式系统（如Web服务）可以更有效地进行数据交换。RESTful则是遵循REST原则的应用程序或接口，它强调接口的无状态性、可缓存性、分层系统等特性。RESTful接口通常使用标准的HTTP方法来操作资源，使得接口更加一致和易于理解和使用。

RESTful接口的基本特点

RESTful接口具有以下基本特点：

无状态性：每个请求都是独立的，客户端不需要维护任何会话状态。每个请求都包含所有必要的信息，服务器不需要记住之前的状态。
统一接口：通过统一的接口来操作资源，使用标准的HTTP方法如GET、POST、PUT、DELETE等。
资源识别：每个资源都有一个唯一的标识符（URI），可以通过这个标识符来操作资源。
分层系统：客户端不能直接与服务器通信，而是通过中间层代理来实现。这有助于提高系统的可扩展性和安全性。
缓存机制：通过HTTP响应头中的缓存控制信息来提高响应效率，减少网络负载。
自描述：响应消息通常包含必要的元数据，使得客户端能够理解如何处理这些数据。
代码与数据分离：客户端与服务器的数据格式（如JSON、XML）是独立的，客户端可以使用不同的数据格式来与服务器通信。

示例代码

下面是一个简单的RESTful API示例，使用Python的Flask库来创建一个基本的RESTful接口：

from flask import Flask, jsonify, request

app = Flask(__name__)

tasks = [
    {"id": 1, "title": "Buy groceries", "description": "Milk, Cheese, Pizza, Fruit, Tylenol", "done": False},
    {"id": 2, "title": "Learn Python", "description": "Need to find a good Python tutorial on the web", "done": False}
]

# GET请求：获取所有任务
@app.route('/tasks', methods=['GET'])
def get_tasks():
    return jsonify({'tasks': tasks})

# GET请求：获取单个任务
@app.route('/tasks/<int:task_id>', methods=['GET'])
def get_task(task_id):
    task = next((task for task in tasks if task['id'] == task_id), None)
    if task is not None:
        return jsonify(task)
    else:
        return jsonify({"error": "Task not found"}), 404

# POST请求：创建任务
@app.route('/tasks', methods=['POST'])
def create_task():
    if not request.json or not 'title' in request.json:
        return jsonify({"error": "Bad request"}), 400
    task = {
        'id': tasks[-1]['id'] + 1,
        'title': request.json['title'],
        'description': request.json.get('description', ""),
        'done': False
    }
    tasks.append(task)
    return jsonify(task)

# PUT请求：更新任务
@app.route('/tasks/<int:task_id>', methods=['PUT'])
def update_task(task_id):
    task = next((task for task in tasks if task['id'] == task_id), None)
    if task is None:
        return jsonify({"error": "Task not found"}), 404
    task['title'] = request.json.get('title', task['title'])
    task['description'] = request.json.get('description', task['description'])
    task['done'] = request.json.get('done', task['done'])
    return jsonify(task)

# DELETE请求：删除任务
@app.route('/tasks/<int:task_id>', methods=['DELETE'])
def delete_task(task_id):
    task = next((task for task in tasks if task['id'] == task_id), None)
    if task is None:
        return jsonify({"error": "Task not found"}), 404
    tasks.remove(task)
    return jsonify({"result": True})

if __name__ == '__main__':
    app.run(debug=True)

这个示例代码展示了如何使用Flask创建一个基本的RESTful API，包含获取、创建、更新和删除任务的操作。每个操作都对应一个HTTP请求方法，并返回JSON格式的数据。

RESTful接口的资源与资源标识

RESTful接口中的核心概念是资源。资源可以是任何可命名的实体，如用户、订单、文章等。资源的表现形式可以是各种数据格式，如JSON、XML、HTML等。

资源及其表现形式

资源是RESTful接口中的基本单元，每个资源都有一个唯一的标识符（URI）。资源的表现形式取决于客户端和服务器之间的约定，常见的数据格式包括JSON、XML和HTML。JSON因为其轻量级和易读性而成为RESTful接口中最常用的数据格式之一。

资源标识与URI的设计

资源标识是通过URI（Uniform Resource Identifier）来表示的，URI是资源的唯一标识符，可以是绝对路径（如/api/users/1）或相对路径（如users/1）。URI的设计应该清晰、简洁，易于理解和记忆。例如，/api/users/1 表示获取用户ID为1的资源，而 /api/users 则表示获取所有用户的资源。最佳实践包括使用名词而非动词、避免嵌套过多的层级以及使用合适的数据格式来表示资源。

示例代码

下面是一个简单的RESTful API示例，展示了资源标识与URI的设计：

from flask import Flask, jsonify, request

app = Flask(__name__)

users = [
    {"id": 1, "name": "Alice", "email": "alice@example.com"},
    {"id": 2, "name": "Bob", "email": "bob@example.com"}
]

# GET请求：获取所有用户
@app.route('/api/users', methods=['GET'])
def get_users():
    return jsonify({'users': users})

# GET请求：获取单个用户
@app.route('/api/users/<int:user_id>', methods=['GET'])
def get_user(user_id):
    user = next((user for user in users if user['id'] == user_id), None)
    if user is not None:
        return jsonify(user)
    else:
        return jsonify({"error": "User not found"}), 404

# POST请求：创建用户
@app.route('/api/users', methods=['POST'])
def create_user():
    if not request.json or not 'name' in request.json:
        return jsonify({"error": "Bad request"}), 400
    user = {
        'id': users[-1]['id'] + 1,
        'name': request.json['name'],
        'email': request.json.get('email', "")
    }
    users.append(user)
    return jsonify(user)

# PUT请求：更新用户
@app.route('/api/users/<int:user_id>', methods=['PUT'])
def update_user(user_id):
    user = next((user for user in users if user['id'] == user_id), None)
    if user is None:
        return jsonify({"error": "User not found"}), 404
    user['name'] = request.json.get('name', user['name'])
    user['email'] = request.json.get('email', user['email'])
    return jsonify(user)

# DELETE请求：删除用户
@app.route('/api/users/<int:user_id>', methods=['DELETE'])
def delete_user(user_id):
    user = next((user for user in users if user['id'] == user_id), None)
    if user is None:
        return jsonify({"error": "User not found"}), 404
    users.remove(user)
    return jsonify({"result": True})

if __name__ == '__main__':
    app.run(debug=True)

这个示例代码展示了如何使用Flask创建一个基本的RESTful API，包含获取、创建、更新和删除用户的操作。每个操作都对应一个HTTP请求方法，并返回JSON格式的数据。URI的设计清晰简洁，易于理解和记忆。

RESTful接口的HTTP方法与RESTful操作

HTTP方法是定义RESTful接口操作的基础，常见的HTTP方法包括GET、POST、PUT、DELETE等。这些方法对应了不同的操作，能够更好地利用HTTP协议提供的功能。

GET请求：获取资源

GET请求用于获取资源的信息，它不修改服务器上的任何资源。GET请求的安全性较高，因为它是幂等性的（即多次请求得到的结果是一样的），不会对服务器上的数据产生影响。

示例代码

下面是一个简单的GET请求示例，使用Python的requests库来获取资源：

import requests

# 获取所有用户
response = requests.get('http://localhost:5000/api/users')
print(response.json())

# 获取单个用户
response = requests.get('http://localhost:5000/api/users/1')
print(response.json())

这个示例代码展示了如何使用Python的requests库发送GET请求来获取资源。第一个请求获取所有用户的信息，第二个请求获取用户ID为1的信息。响应数据以JSON格式返回，可以通过response.json()方法来解析。

POST请求：创建资源

POST请求用于创建新的资源，它将数据发送到服务器以创建一个新的资源。POST请求不是幂等性的，同一个POST请求可能会导致不同的结果，因为它可能会影响服务器上的数据。

示例代码

下面是一个简单的POST请求示例，使用Python的requests库来创建资源：

import requests
import json

# 创建新用户
new_user = {
    "name": "Charlie",
    "email": "charlie@example.com"
}
response = requests.post('http://localhost:5000/api/users', data=json.dumps(new_user), headers={"Content-Type": "application/json"})
print(response.json())

这个示例代码展示了如何使用Python的requests库发送POST请求来创建新的资源。第一个请求创建一个新的用户，响应数据以JSON格式返回，可以通过response.json()方法来解析。

PUT请求：更新资源

PUT请求用于更新资源的信息。PUT请求是幂等性的，即多次发送相同的PUT请求应该会产生相同的结果。PUT请求用于替换现有的资源，如果客户端只想更新资源的一部分，可以使用PATCH请求。

示例代码

下面是一个简单的PUT请求示例，使用Python的requests库来更新资源：

import requests
import json

# 更新用户信息
updated_user = {
    "name": "Charlie Updated",
    "email": "charlie-updated@example.com"
}
response = requests.put('http://localhost:5000/api/users/1', data=json.dumps(updated_user), headers={"Content-Type": "application/json"})
print(response.json())

这个示例代码展示了如何使用Python的requests库发送PUT请求来更新资源。第一个请求更新用户ID为1的用户信息，响应数据以JSON格式返回，可以通过response.json()方法来解析。

DELETE请求：删除资源

DELETE请求用于删除资源。DELETE请求是幂等性的，即多次发送相同的DELETE请求应该会产生相同的结果。DELETE请求用于删除指定的资源。

示例代码

下面是一个简单的DELETE请求示例，使用Python的requests库来删除资源：

import requests

# 删除用户
response = requests.delete('http://localhost:5000/api/users/1')
print(response.json())

这个示例代码展示了如何使用Python的requests库发送DELETE请求来删除资源。第一个请求删除用户ID为1的用户，响应数据以JSON格式返回，可以通过response.json()方法来解析。

RESTful接口的常见设计模式

RESTful接口设计中常用的模式和最佳实践包括单资源与资源集合的设计、分页与过滤等。

单资源与资源集合的设计

RESTful接口通常使用资源标识符（URI）来表示单个资源或资源集合。单个资源通过唯一的标识符来表示，而资源集合则通过相对路径来表示。

示例代码

下面是一个简单的RESTful API示例，展示了单资源与资源集合的设计：

from flask import Flask, jsonify, request

app = Flask(__name__)

tasks = [
    {"id": 1, "title": "Buy groceries", "description": "Milk, Cheese, Pizza, Fruit, Tylenol", "done": False},
    {"id": 2, "title": "Learn Python", "description": "Need to find a good Python tutorial on the web", "done": False}
]

# GET请求：获取所有任务
@app.route('/tasks', methods=['GET'])
def get_tasks():
    return jsonify({'tasks': tasks})

# GET请求：获取单个任务
@app.route('/tasks/<int:task_id>', methods=['GET'])
def get_task(task_id):
    task = next((task for task in tasks if task['id'] == task_id), None)
    if task is not None:
        return jsonify(task)
    else:
        return jsonify({"error": "Task not found"}), 404

# POST请求：创建任务
@app.route('/tasks', methods=['POST'])
def create_task():
    if not request.json or not 'title' in request.json:
        return jsonify({"error": "Bad request"}), 400
    task = {
        'id': tasks[-1]['id'] + 1,
        'title': request.json['title'],
        'description': request.json.get('description', ""),
        'done': False
    }
    tasks.append(task)
    return jsonify(task)

# PUT请求：更新任务
@app.route('/tasks/<int:task_id>', methods=['PUT'])
def update_task(task_id):
    task = next((task for task in tasks if task['id'] == task_id), None)
    if task is None:
        return jsonify({"error": "Task not found"}), 404
    task['title'] = request.json.get('title', task['title'])
    task['description'] = request.json.get('description', task['description'])
    task['done'] = request.json.get('done', task['done'])
    return jsonify(task)

# DELETE请求：删除任务
@app.route('/tasks/<int:task_id>', methods=['DELETE'])
def delete_task(task_id):
    task = next((task for task in tasks if task['id'] == task_id), None)
    if task is None:
        return jsonify({"error": "Task not found"}), 404
    tasks.remove(task)
    return jsonify({"result": True})

if __name__ == '__main__':
    app.run(debug=True)

这个示例代码展示了如何使用Flask创建一个基本的RESTful API，包含获取、创建、更新和删除任务的操作。每个操作都对应一个HTTP请求方法，并返回JSON格式的数据。URI的设计清晰简洁，易于理解和记忆。

分页与过滤

分页和过滤是RESTful接口中常见的设计模式，用于处理大量数据。分页允许客户端分批获取资源，而过滤则允许客户端根据特定条件获取资源。

示例代码

下面是一个简单的RESTful API示例，展示了分页与过滤的设计：

from flask import Flask, jsonify, request

app = Flask(__name__)

tasks = [
    {"id": 1, "title": "Buy groceries", "description": "Milk, Cheese, Pizza, Fruit, Tylenol", "done": False},
    {"id": 2, "title": "Learn Python", "description": "Need to find a good Python tutorial on the web", "done": False},
    {"id": 3, "title": "Install dependencies", "description": "npm install", "done": False},
    {"id": 4, "title": "Write code", "description": "Coding is fun!", "done": False}
]

# GET请求：获取所有任务（带分页）
@app.route('/tasks', methods=['GET'])
def get_tasks():
    page = request.args.get('page', 1, type=int)
    per_page = request.args.get('per_page', 10, type=int)
    start = (page - 1) * per_page
    end = start + per_page
    return jsonify({'tasks': tasks[start:end]})

# GET请求：获取分页任务（带过滤）
@app.route('/tasks/<int:done>', methods=['GET'])
def get_tasks_by_done(done):
    page = request.args.get('page', 1, type=int)
    per_page = request.args.get('per_page', 10, type=int)
    start = (page - 1) * per_page
    end = start + per_page
    filtered_tasks = [task for task in tasks if task['done'] == done]
    return jsonify({'tasks': filtered_tasks[start:end]})

if __name__ == '__main__':
    app.run(debug=True)

这个示例代码展示了如何使用Flask创建一个基本的RESTful API，包含获取任务的操作。每个操作都对应一个HTTP请求方法，并返回JSON格式的数据。URI的设计清晰简洁，易于理解和记忆。通过请求参数page和per_page实现了分页功能，通过请求参数done实现了根据任务完成状态的过滤功能。

RESTful接口的认证与安全

认证和安全是确保RESTful接口安全的重要组成部分。认证机制用于验证用户的身份，而安全措施则保护接口免受未授权的访问和攻击。

基本认证

基本认证是一种简单的认证机制，通过在HTTP请求头中传递用户的凭据（用户名和密码）来验证用户的身份。基本认证使用Base64编码来加密用户名和密码，虽然这种机制并不是非常安全，但在某些情况下仍然可以使用。

示例代码

下面是一个简单的RESTful API示例，展示了基本认证的设计：

from flask import Flask, jsonify, request

app = Flask(__name__)

tasks = [
    {"id": 1, "title": "Buy groceries", "description": "Milk, Cheese, Pizza, Fruit, Tylenol", "done": False},
    {"id": 2, "title": "Learn Python", "description": "Need to find a good Python tutorial on the web", "done": False}
]

# 基本认证
def authenticate(username, password):
    if username == 'admin' and password == 'password':
        return True
    return False

@app.route('/tasks', methods=['GET'])
def get_tasks():
    auth = request.authorization
    if not auth or not authenticate(auth.username, auth.password):
        return jsonify({"error": "Authentication required"}), 401

    return jsonify({'tasks': tasks})

if __name__ == '__main__':
    app.run(debug=True)

这个示例代码展示了如何使用Flask创建一个基本的RESTful API，包含获取任务的操作。每个操作都对应一个HTTP请求方法，并返回JSON格式的数据。在get_tasks路由中，通过request.authorization获取认证信息，并使用自定义的authenticate函数来验证用户名和密码。如果认证失败，则返回401状态码并提示“Authentication required”。

Token认证

Token认证是一种更安全的认证机制，通过生成一个唯一的Token来验证用户的身份。Token通常存储在客户端的本地存储或Cookie中，并在每次请求时传递给服务器。Token认证可以使用多种方案，如JWT（JSON Web Token）。

示例代码

下面是一个简单的RESTful API示例，展示了Token认证的设计：

from flask import Flask, jsonify, request
import jwt
import datetime

app = Flask(__name__)
app.config['SECRET_KEY'] = 'secret_key'

tasks = [
    {"id": 1, "title": "Buy groceries", "description": "Milk, Cheese, Pizza, Fruit, Tylenol", "done": False},
    {"id": 2, "title": "Learn Python", "description": "Need to find a good Python tutorial on the web", "done": False}
]

# 生成Token
def generate_token(username):
    token = jwt.encode({'username': username, 'exp': datetime.datetime.utcnow() + datetime.timedelta(minutes=30)}, app.config['SECRET_KEY'], algorithm='HS256')
    return token

@app.route('/login', methods=['POST'])
def login():
    if request.json and 'username' in request.json and 'password' in request.json:
        if request.json['username'] == 'admin' and request.json['password'] == 'password':
            token = generate_token(request.json['username'])
            return jsonify({"token": token}), 200
    return jsonify({"error": "Invalid credentials"}), 401

@app.route('/tasks', methods=['GET'])
def get_tasks():
    token = request.headers.get('Authorization').split(' ')[1]
    try:
        jwt.decode(token, app.config['SECRET_KEY'], algorithms=['HS256'])
        return jsonify({'tasks': tasks})
    except jwt.ExpiredSignatureError:
        return jsonify({"error": "Token expired"}), 401
    except jwt.InvalidTokenError:
        return jsonify({"error": "Invalid token"}), 401

if __name__ == '__main__':
    app.run(debug=True)

这个示例代码展示了如何使用Flask创建一个基本的RESTful API，包含获取任务的操作。每个操作都对应一个HTTP请求方法，并返回JSON格式的数据。在login路由中，通过jwt.encode函数生成一个Token，并在每次请求时通过jwt.decode函数验证Token的有效性。如果Token过期或无效，则返回401状态码并提示“Token expired”或“Invalid token”。

RESTful接口的测试方法

RESTful接口的测试可以通过多种工具来实现，例如Postman和curl命令。

使用Postman测试接口

Postman是一个流行的API测试工具，它允许用户通过图形界面发送HTTP请求并查看响应结果。Postman支持多种HTTP方法，可以方便地进行GET、POST、PUT、DELETE等操作。Postman还可以保存接口的请求和响应，方便重复测试。

示例代码

下面是一个简单的RESTful API示例，展示了如何使用Postman测试接口：

打开Postman并创建一个新的请求。
在请求类型中选择GET。
在请求URL中输入http://localhost:5000/api/users。
发送请求并查看响应结果。

这个示例代码展示了如何使用Postman测试RESTful API的GET请求。通过Postman的图形界面，可以方便地发送HTTP请求并查看响应结果。Postman还可以保存接口的请求和响应，方便重复测试。

使用curl命令测试接口

curl是一个命令行工具，用于发送HTTP请求并获取响应结果。curl支持多种HTTP方法，可以方便地进行GET、POST、PUT、DELETE等操作。curl还可以通过命令行参数来设置请求头和请求体，方便测试各种场景。

示例代码

下面是一个简单的RESTful API示例，展示了如何使用curl命令测试接口：

# 获取所有用户
curl -X GET http://localhost:5000/api/users

# 获取单个用户
curl -X GET http://localhost:5000/api/users/1

# 创建新用户
curl -X POST http://localhost:5000/api/users -H "Content-Type: application/json" -d '{"name": "Charlie", "email": "charlie@example.com"}'

# 更新用户信息
curl -X PUT http://localhost:5000/api/users/1 -H "Content-Type: application/json" -d '{"name": "Charlie Updated", "email": "charlie-updated@example.com"}'

# 删除用户
curl -X DELETE http://localhost:5000/api/users/1

这个示例代码展示了如何使用curl命令测试RESTful API的各种操作。通过命令行参数，可以方便地发送HTTP请求并获取响应结果。curl还可以通过命令行参数来设置请求头和请求体，方便测试各种场景。

点击查看更多内容

为 TA 点赞

若觉得本文不错，就分享一下吧！

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

素胚勾勒不出你

手记
篇

粉丝

53

获赞与收藏

274

关注作者，订阅最新文章

阅读免费教程

Hibernate 入门教程

29个小节 6360 93

HTTP 入门教程

28个小节 37784 648

后端通用面试教程

41个小节 30589 343

推荐

评论

收藏

共同学习，写下你的评论



感谢您的支持，我会继续努力的～

扫码打赏，你说多少就多少

赞赏金额会直接到老师账户

支付方式

打开微信扫一扫，即可进行扫码打赏哦

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

恭喜你，你的运气太好了，居然抽中了 100个积分！

恭喜你，抽中了价值元的专栏！

太棒了，直接落到你账户里！

积分商城里的罗技鼠标、机械键盘、
Kindle 阅读器、小米平衡车
Apple iPad （10.2英寸）、大额优惠券
在等着你去兑换了噢

作者：

免费赠送

兑换码：1111222211 复制

优惠券可用于购买实战课、体系课
无门槛使用

先去看看，有什么好东西马上兑换我爱学习，选课去


热搜

最近搜索清空

RESTful接口资料：新手入门教程

REST和RESTful的概念

RESTful接口的基本特点

示例代码

资源及其表现形式

资源标识与URI的设计

示例代码

GET请求：获取资源

示例代码

POST请求：创建资源

示例代码

PUT请求：更新资源

示例代码

DELETE请求：删除资源

示例代码

单资源与资源集合的设计

示例代码

分页与过滤

示例代码

基本认证

示例代码

Token认证

示例代码

使用Postman测试接口

示例代码

使用curl命令测试接口

示例代码

阅读免费教程