用Python写一个简单的api接口_python api接口开发

python框架有很多，例如：Flask，Django，FastAPI 等。本文将使用 Flask 来编写 API 接口。

安装Flask

首先，您需要安装 Flask：

pip install flask
1

写主程序

接下来，我们可以创建一个名为 app.py 的文件，在其中编写 Flask 应用程序代码：

from flask import Flask, request

app = Flask(__name__)

@app.route('/api', methods=['GET'])
def api():
    name = request.args.get('name')
    if name:
        return "Hello, " + name
    else:
        return "Hello, World!"

if __name__ == '__main__':
    app.run(debug=True)
1
2
3
4
5
6
7
8
9
10
11
12
13
14

运行代码

python app.py
1

在浏览器中访问 http://localhost:5000/api，应该会返回 “Hello, World!”。
如果向该 URL 添加参数，例如 http://localhost:5000/api?name=YourName，则会返回 “Hello, YourName”。

我们还可以给它添加一个简单的token验证

以下代码来给 API 接口添加一个简单的 token 验证：

from flask import Flask, request

app = Flask(__name__)

@app.route('/api', methods=['GET'])
def api():
    token = request.args.get('token')
    if token != 'secret_token':
        return "Invalid token", 401
    name = request.args.get('name')
    if name:
        return "Hello, " + name
    else:
        return "Hello, World!"

if __name__ == '__main__':
    app.run(debug=True)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

在上面的代码中，我们添加了一个 token 参数，并在该参数不为 secret_token 时返回一个 “Invalid token” 的错误响应（HTTP 状态代码 401）。
在实际生产环境中，应该使用更强大的身份验证方法，而不是仅仅使用简单的 token，但在本例中可以作为一个简单的示例。
在生产环境中，您应该使用更复杂的身份验证方法，例如：OAuth2，JWT 等。

在使用 Flask 的情况下，您可以使用第三方库，例如 Flask-OAuthlib 或 Flask-JWT-Extended 来实现身份验证。

下面是使用 Flask-JWT-Extended 实现身份验证的示例代码：

from flask import Flask, request
from flask_jwt_extended import (
    JWTManager, jwt_required, create_access_token,
    get_jwt_identity
)

app = Flask(__name__)

app.config['JWT_SECRET_KEY'] = 'secret-key'

jwt = JWTManager(app)

@app.route('/login', methods=['POST'])
def login():
    username = request.json.get('username', None)
    password = request.json.get('password', None)

    if username != 'test' or password != 'test':
        return {'message': 'Bad username or password'}, 401

    # identity is a simple string, like a username
    access_token = create_access_token(identity=username)
    return {'access_token': access_token}, 200

@app.route('/api', methods=['GET'])
@jwt_required
def api():
    current_user = get_jwt_identity()
    return "Hello, " + current_user

if __name__ == '__main__':
    app.run(debug=True)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

在上面的代码中，我们定义了两个路由：/login 和 /api。在 /login 中，我们检查用户名和密码，如果正确，则创建一个 JWT 访问令牌并将其返回给用户。在 /api 中，我们使用 jwt_required 装饰器来确保该 API 只能被拥有 JWT 令牌的用户访问。

在实际生产环境中，应该使用更复杂的身份验证方法，例如：OAuth2，JWT 等。另外，还需要仔细考虑 JWT 秘密密钥的安全性，以防止任何恶意用户恢复或篡改 JWT 令牌。

为了确保身份验证过程的安全性，还应该在客户端使用 HTTPS 安全套接字层 (SSL/TLS) 连接到 API 接口，以防止数据在网络中被窃取。

请注意，这仅是一个简单的 JWT 身份验证示例，在生产环境中，可能需要更复杂的验证方法。因此，请确保在使用 JWT 或任何其他身份验证方法之前，完全了解其安全性，以确保你的 API 接口不会受到攻击。