使用Python创建自己的API:初学者指南 - Medium

作者:API传播员 · 2025-11-16 · 阅读时间:4分钟
本文详细介绍了使用Python和Flask框架创建API的初学者指南,包括API定义、环境准备、安装Flask、创建API终结点如日期和日历查询,以及运行和测试API的步骤,帮助初学者快速上手Python API开发。

使用Python创建自己的API:初学者指南

应用程序接口)是实现不同系统之间通信的关键工具。通过API,我们可以轻松地共享数据和功能。本文将带您一步步使用Python和Flask框架创建一个简单的API,即使您是初学者也能轻松上手。


什么是API?

API,全称为应用程序接口,是一组定义和协议,用于构建和集成软件应用程序。它允许不同的应用程序通过标准化的方式进行通信。例如,您可以通过API访问天气数据、股票信息,甚至控制硬件设备。


为什么选择Python和Flask?

构建API的理想选择。


环境准备

在开始之前,请确保您的系统上已安装Python。如果尚未安装,可以从Python官网下载并安装最新版本。


安装Flask

首先,我们需要安装Flask库。您可以通过以下命令快速安装:

pip install flask

安装完成后,您就可以开始构建API了。


创建API终结点

以下是一个简单的Flask应用程序示例,它包含多个API终结点,用于执行不同的系统命令:

from flask import Flask, jsonify
import subprocess

app = Flask(__name__)@app.route('/date', methods=['GET'])
def get_date():
    result = subprocess.check_output(['date']).decode('utf-8')
    return jsonify({'date': result.strip()})@app.route('/cal', methods=['GET'])
def get_cal():
    result = subprocess.check_output(['cal']).decode('utf-8')
    return jsonify({'calendar': result.strip()})@app.route('/docker', methods=['GET'])
def get_docker():
    result = subprocess.check_output(['docker', 'ps']).decode('utf-8')
    return jsonify({'docker': result.strip()})@app.route('/cls', methods=['GET'])
def get_cls():
    result = subprocess.check_output(['cls']).decode('utf-8')
    return jsonify({'cls': result.strip()})if __name__ == '__main__':
    app.run()

代码说明:

  1. @app.route 装饰器:定义了API的路由和请求方法。
  2. subprocess.check_output:执行系统命令并获取其输出。
  3. jsonify:将Python字典转换为JSON格式的响应。

以上代码创建了四个API终结点:

  • /date:返回当前日期。
  • /cal:返回日历信息。
  • /docker:返回当前运行的Docker容器列表。
  • /cls:执行清屏命令。

运行API

将上述代码保存为 api.py 文件,然后在终端中运行以下命令启动API服务:

python api.py

运行后,您将看到类似以下的输出:

* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

此时,您的API服务已成功启动,您可以通过浏览器或工具(如Postman)访问这些终结点。例如,访问 http://127.0.0.1:5000/date 将返回当前日期的JSON响应。


通过本文的介绍,您已经学会了如何使用Python和Flask创建自己的API。这是一个简单的入门示例,您可以根据需求扩展功能,例如添加数据库支持、用户认证等。希望这篇文章能为您的API开发之旅提供帮助!

原文链接: https://medium.com/@asvinjangid.kumar/creating-your-own-api-in-python-a-beginners-guide-59f4dd18d301