📜  如何在烧瓶中创建 ajax api - Javascript (1)

📅  最后修改于: 2023-12-03 15:24:39.555000             🧑  作者: Mango

如何在烧瓶中创建 AJAX API - JavaScript

AJAX (Asynchronous JavaScript and XML) 是一种基于web的技术,可以在不刷新页面的情况下向服务器发送请求和从服务器接收响应。在现代网站中,AJAX是非常重要的一部分,因为它提供了一种流畅的用户体验,使用户不必在每个页面上进行完整的页面刷新。

在本教程中,我们将学习如何在Python web框架烧瓶(Flask)中创建AJAX API。

步骤1:安装Flask

在开始创建AJAX API之前,我们需要安装Flask。我们可以使用pip来安装它。在终端中运行以下命令:

pip install Flask
步骤2:创建Flask App

创建Flask App 并导入所需的模块:

from flask import Flask, request, jsonify

app = Flask(__name__)
步骤3:创建API端点

接下来,我们将创建一些API端点,以便客户端可以向服务器发送请求并从服务器接收响应。在这里,我们将仅处理GET请求。

@app.route('/hello')
def hello_world():
    return 'Hello World!'

@app.route('/addition', methods=['GET'])
def addition():
    num1 = request.args.get('num1')
    num2 = request.args.get('num2')
    sum = int(num1) + int(num2)
    return jsonify({'sum': sum})

在这里,我们创建了两个API端点:

  • /hello - 这个端点不需要任何参数,它只是返回一个字符串 "Hello World!"
  • /addition - 这个端点需要两个整数参数num1和num2,它将这些数字相加并返回结果。
步骤4:启动API服务

最后,我们启动Flask应用程序,以便客户端可以通过API访问我们创建的端点:

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

现在,我们可以使用以下命令在终端中启动API服务:

python app.py
步骤5:使用AJAX从客户端调用API

现在我们已经为客户端创建了API,我们可以使用AJAX从客户端调用它。在以下示例中,我们将使用jQuery库来从客户端调用 /addition 端点并接收响应。

<!DOCTYPE html>
<html>
  <head>
    <title>AJAX API Example - Flask</title>
    <script src="https://code.jquery.com/jquery-3.5.1.min.js"></script>
    <script>
      $(document).ready(function() {
        $('#submit').click(function() {
          var num1 = $('#num1').val();
          var num2 = $('#num2').val();

          $.ajax({
            url: '/addition',
            data: {'num1': num1, 'num2': num2},
            dataType: 'json',
            success: function(data) {
              $('#result').text('Sum is: ' + data.sum);
            }
          });
        });
      });
    </script>
  </head>
  <body>
    <h1>AJAX API Example - Flask</h1>
    <label for="num1">Number 1:</label>
    <input type="number" id="num1" name="num1" /><br />
    <label for="num2">Number 2:</label>
    <input type="number" id="num2" name="num2" /><br />
    <button id="submit">Add</button><br />
    <div id="result"></div>
  </body>
</html>

在这里,我们创建了两个输入字段和一个“Add”按钮,用户可以输入两个数字并按下“Add”按钮来调用API。当用户按下“Add”按钮时,我们使用ajax方法向 /addition 端点发送请求,并在成功时将结果显示在页面上。

以上就是如何在Python web框架烧瓶(Flask)中创建AJAX API的教程。在本教程中,我们学习了如何创建API端点、如何从客户端调用API以及如何使用ajax方法进行响应处理。现在你可以使用这些知识在自己的Python应用程序中创建AJAX API了。