python的api文档_python 编写api接口

激活谷笔记 • 2026-04-29 10:20 • 阅读 8

在Python中编写API接口通常使用Web框架，如Flask或Django。以下是使用Flask框架编写API接口的基本步骤和示例代码：

步骤

1. 安装Flask库：

pip install flask

2. 创建一个新的Python文件，例如`app.py`。

3. 在文件开头导入所需的库和模块：

python

from flask import Flask, request, jsonify

4. 创建一个应用程序实例：

python

app = Flask（__name__）

5. 定义API接口的路由和处理函数：

python

@app.route（'/api/hello', methods=['GET']）

def hello（）:

return 'Hello, World!'

6. 在处理函数中编写代码来处理请求并返回相应的数据，可以使用JSON格式返回数据：

python

@app.route（'/api/hello', methods=['GET']）

def hello（）:

name = request.args.get（'name', 'World'）

return f'Hello, {name}!'

7. 运行应用程序：

python

if __name__ == '__main__':

app.run（debug=True）

示例代码

python

from flask import Flask, request, jsonify

app = Flask（__name__）

@app.route（'/api/hello', methods=['GET']）

def hello（）:

name = request.args.get（'name', 'World'）

return f'Hello, {name}!'

@app.route（'/api/add', methods=['POST']）

def add（）:

data = request.get_json（）

a = data.get（'a', 0）

b = data.get（'b', 0）

return jsonify（result=a + b）

if __name__ == '__main__':

app.run（debug=True）

测试API

使用HTTP客户端工具（如Postman或cURL）发送请求并验证返回的数据。

例如，使用cURL发送GET请求：

curl "http://127.0.0.1:5000/api/hello？name=Alice"

发送POST请求：

curl -X POST -H "Content-Type: application/json" -d '{"a": 1, "b": 2}' http://127.0.0.1:5000/api/add

以上示例展示了如何使用Flask框架创建简单的API接口。您可以根据需要添加更多路由和处理函数来扩展您的API功能

python的api文档_python 编写api接口

相关推荐