使用Python构建简单的RESTful API

简介: 使用Python构建简单的RESTful API

使用Python构建简单的RESTful API

在现代软件开发中,RESTful API已经成为了不同系统之间数据交换的标配。Python,作为一种流行且功能强大的编程语言,提供了多种方式来构建RESTful API。在本文中,我们将使用Flask这个轻量级的Web框架来演示如何创建一个简单的RESTful API。


一、安装Flask

首先,你需要安装Flask。你可以使用pip这个Python包管理器来安装:

pip install Flask


二、创建基本的Flask应用

接下来,我们创建一个简单的Flask应用,它将提供一个RESTful API来管理一个假设的“书籍”资源。

from flask import Flask, request, jsonify
app = Flask(__name__)
# 假设的书籍数据存储
books = [
    {"id": 1, "title": "Book 1", "author": "Author 1"},
    {"id": 2, "title": "Book 2", "author": "Author 2"}
]
# 获取所有书籍的API端点
@app.route('/books', methods=['GET'])
def get_books():
    return jsonify({'books': books})
# 获取特定书籍的API端点
@app.route('/books/<int:book_id>', methods=['GET'])
def get_book(book_id):
    book = next((item for item in books if item['id'] == book_id), None)
    return jsonify(book) if book else ('', 404)
# 添加新书籍的API端点
@app.route('/books', methods=['POST'])
def add_book():
    if not request.json or not 'title' in request.json or not 'author' in request.json:
        return jsonify({'error': 'Missing title or author in the JSON body'}), 400
    book = {
        'id': books[-1]['id'] + 1,
        'title': request.json['title'],
        'author': request.json['author']
    }
    books.append(book)
    return jsonify(book), 201
# 更新书籍的API端点
@app.route('/books/<int:book_id>', methods=['PUT'])
def update_book(book_id):
    book = next((item for item in books if item['id'] == book_id), None)
    if book is None:
        return ('', 404)
    if not request.json:
        return jsonify({'error': 'No JSON body provided'}), 400
    book.update(request.json)
    return jsonify(book)
# 删除书籍的API端点
@app.route('/books/<int:book_id>', methods=['DELETE'])
def delete_book(book_id):
    global books
    books = [book for book in books if book['id'] != book_id]
    return '', 204
if __name__ == '__main__':
    app.run(debug=True)


三、测试RESTful API

启动Flask应用后,你可以使用工具如curl、Postman或任何你喜欢的HTTP客户端来测试这些API端点。以下是一些测试示例:

  1. 获取所有书籍
curl http://127.0.0.1:5000/books
  1. 获取特定书籍
curl http://127.0.0.1:5000/books/1
  1. 添加新书籍
curl -X POST -H "Content-Type: application/json" -d '{"title":"Book 3", "author":"Author 3"}' http://127.0.0.1:5000/books
  1. 更新书籍
curl -X PUT -H "Content-Type: application/json" -d '{"title":"Updated Book 1", "author":"Updated Author 1"}' http://127.0.0.1:5000/books/1
  1. 删除书籍
curl -X DELETE http://127.0.0.1:5000/books/1
目录
相关文章
|
8月前
|
JSON 算法 API
Python采集淘宝商品评论API接口及JSON数据返回全程指南
Python采集淘宝商品评论API接口及JSON数据返回全程指南
|
8月前
|
JSON API 数据安全/隐私保护
Python采集淘宝拍立淘按图搜索API接口及JSON数据返回全流程指南
通过以上流程,可实现淘宝拍立淘按图搜索的完整调用链路,并获取结构化的JSON商品数据,支撑电商比价、智能推荐等业务场景。
|
9月前
|
安全 Java API
使用 Java 构建强大的 REST API 的四个基本技巧
本文结合探险领域案例,分享Java构建REST API的四大核心策略:统一资源命名、版本控制与自动化文档、安全防护及标准化异常处理,助力开发者打造易用、可维护、安全可靠的稳健API服务。
522 116
|
9月前
|
缓存 监控 供应链
唯品会自定义 API 自定义操作深度分析及 Python 实现
唯品会开放平台提供丰富API,支持商品查询、订单管理、促销活动等电商全流程操作。基于OAuth 2.0认证机制,具备安全稳定的特点。通过组合调用基础接口,可实现数据聚合、流程自动化、监控预警及跨平台集成,广泛应用于供应链管理、数据分析和智能采购等领域。结合Python实现方案,可高效完成商品搜索、订单分析、库存监控等功能,提升电商运营效率。
|
8月前
|
人工智能 API 开发工具
构建AI智能体:一、初识AI大模型与API调用
本文介绍大模型基础知识及API调用方法,涵盖阿里云百炼平台密钥申请、DashScope SDK使用、Python调用示例(如文本情感分析、图像文字识别),助力开发者快速上手大模型应用开发。
2839 18
构建AI智能体:一、初识AI大模型与API调用
|
8月前
|
Cloud Native 算法 API
Python API接口实战指南:从入门到精通
🌟蒋星熠Jaxonic,技术宇宙的星际旅人。深耕API开发,以Python为舟,探索RESTful、GraphQL等接口奥秘。擅长requests、aiohttp实战,专注性能优化与架构设计,用代码连接万物,谱写极客诗篇。
1626 1
Python API接口实战指南:从入门到精通
|
9月前
|
JSON API 数据安全/隐私保护
Python采集淘宝评论API接口及JSON数据返回全流程指南
Python采集淘宝评论API接口及JSON数据返回全流程指南
|
12月前
|
缓存 安全 API
RESTful与GraphQL:电商API接口设计的技术细节与适用场景
本文对比了RESTful与GraphQL这两种主流电商API接口设计方案。RESTful通过资源与HTTP方法定义操作,简单直观但可能引发过度或欠获取数据问题;GraphQL允许客户端精确指定所需字段,提高灵活性和传输效率,但面临深度查询攻击等安全挑战。从性能、灵活性、安全性及适用场景多维度分析,RESTful适合资源导向场景,GraphQL则适用于复杂数据需求。实际开发中需根据业务特点选择合适方案,或结合两者优势,以优化用户体验与系统性能。
|
12月前
|
JSON 编解码 API
Go语言网络编程:使用 net/http 构建 RESTful API
本章介绍如何使用 Go 语言的 `net/http` 标准库构建 RESTful API。内容涵盖 RESTful API 的基本概念及规范,包括 GET、POST、PUT 和 DELETE 方法的实现。通过定义用户数据结构和模拟数据库,逐步实现获取用户列表、创建用户、更新用户、删除用户的 HTTP 路由处理函数。同时提供辅助函数用于路径参数解析,并展示如何设置路由器启动服务。最后通过 curl 或 Postman 测试接口功能。章节总结了路由分发、JSON 编解码、方法区分、并发安全管理和路径参数解析等关键点,为更复杂需求推荐第三方框架如 Gin、Echo 和 Chi。
|
XML JSON API
Understanding RESTful API and Web Services: Key Differences and Use Cases
在现代软件开发中,RESTful API和Web服务均用于实现系统间通信,但各有特点。RESTful API遵循REST原则,主要使用HTTP/HTTPS协议,数据格式多为JSON或XML,适用于无状态通信;而Web服务包括SOAP和REST,常用于基于网络的API,采用标准化方法如WSDL或OpenAPI。理解两者区别有助于选择适合应用需求的解决方案,构建高效、可扩展的应用程序。

推荐镜像

更多