Hướng dẫn api to run python script - api để chạy tập lệnh python

Phương pháp HTTP

REST API lắng nghe các phương thức HTTP như

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

Mặc dù có nhiều phương thức HTTP, năm phương thức được liệt kê dưới đây là các phương thức được sử dụng phổ biến nhất với API REST:

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

Ứng dụng máy khách API REST có thể sử dụng năm phương thức HTTP này để quản lý trạng thái tài nguyên trong dịch vụ web.

Mã trạng thái

Khi API REST nhận và xử lý yêu cầu HTTP, nó sẽ trả về phản hồi HTTP. Bao gồm trong phản hồi này là mã trạng thái HTTP. Mã này cung cấp thông tin về kết quả của yêu cầu. Một ứng dụng gửi các yêu cầu đến API có thể kiểm tra mã trạng thái và thực hiện các hành động dựa trên kết quả. Những hành động này có thể bao gồm xử lý lỗi hoặc hiển thị thông báo thành công cho người dùng.HTTP response. Included in this response is an HTTP status code. This code provides information about the results of the request. An application sending requests to the API can check the status code and perform actions based on the result. These actions could include handling errors or displaying a success message to a user.

Dưới đây là danh sách các mã trạng thái phổ biến nhất được trả về bởi API REST:

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

Yêu cầu đã bị dị tật.

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/10"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 10, 'title': 'illo est ... aut', 'completed': True}

>>> todo = {"userId": 1, "title": "Wash car", "completed": True}
>>> response = requests.put(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Wash car', 'completed': True, 'id': 10}

>>> response.status_code
200

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/10"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 10, 'title': 'illo est ... aut', 'completed': True}

>>> todo = {"userId": 1, "title": "Wash car", "completed": True}
>>> response = requests.put(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Wash car', 'completed': True, 'id': 10}

>>> response.status_code
200

Thực thể không thể qua được

Dữ liệu yêu cầu được định dạng đúng nhưng chứa dữ liệu không hợp lệ hoặc thiếu.

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/10"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 10, 'title': 'illo est ... aut', 'completed': True}

>>> todo = {"userId": 1, "title": "Wash car", "completed": True}
>>> response = requests.put(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Wash car', 'completed': True, 'id': 10}

>>> response.status_code
200

Lỗi máy chủ nội bộ

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

Tạo một tài nguyên mới.

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

Các điểm cuối được liệt kê ở trên chỉ đại diện cho một tài nguyên trong hệ thống. API REST sẵn sàng sản xuất thường có hàng chục hoặc thậm chí hàng trăm điểm cuối khác nhau để quản lý các tài nguyên trong dịch vụ web.

LẤY

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

Để kiểm tra

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

Để thử điều này, hãy khởi động Python REPLED và chạy các lệnh sau để gửi yêu cầu

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>>

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

Mã này gọi

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

Dữ liệu phản hồi được định dạng là JSON, một kho lưu trữ giá trị khóa tương tự như từ điển Python. Nó có một định dạng dữ liệu rất phổ biến và định dạng trao đổi thực tế cho hầu hết các API REST.

Ngoài việc xem dữ liệu JSON từ API, bạn cũng có thể xem những thứ khác về

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

>>>

>>> response.status_code
200

>>> response.headers["Content-Type"]
'application/json; charset=utf-8'

Mã này gọi

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

Dữ liệu phản hồi được định dạng là JSON, một kho lưu trữ giá trị khóa tương tự như từ điển Python. Nó có một định dạng dữ liệu rất phổ biến và định dạng trao đổi thực tế cho hầu hết các API REST.

Ngoài việc xem dữ liệu JSON từ API, bạn cũng có thể xem những thứ khác về

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

{
    "userId": 1,
    "title": "Buy milk",
    "completed": false
}

Tại đây, bạn truy cập

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

>>>

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

Mã này gọi

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

Dữ liệu phản hồi được định dạng là JSON, một kho lưu trữ giá trị khóa tương tự như từ điển Python. Nó có một định dạng dữ liệu rất phổ biến và định dạng trao đổi thực tế cho hầu hết các API REST.

Ngoài việc xem dữ liệu JSON từ API, bạn cũng có thể xem những thứ khác về

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

>>>

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

Mã này gọi

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

Dữ liệu phản hồi được định dạng là JSON, một kho lưu trữ giá trị khóa tương tự như từ điển Python. Nó có một định dạng dữ liệu rất phổ biến và định dạng trao đổi thực tế cho hầu hết các API REST.

Ngoài việc xem dữ liệu JSON từ API, bạn cũng có thể xem những thứ khác về

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

Tại đây, bạn truy cập

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

BƯU KIỆN

Bây giờ, hãy xem cách bạn sử dụng dữ liệu

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

JSON này chứa thông tin cho một mục

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

>>>

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/10"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 10, 'title': 'illo est ... aut', 'completed': True}

>>> todo = {"userId": 1, "title": "Wash car", "completed": True}
>>> response = requests.put(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Wash car', 'completed': True, 'id': 10}

>>> response.status_code
200

Mã này gọi

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

VÁ

Tiếp theo, bạn sẽ sử dụng

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

Bạn sẽ sử dụng cùng một

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

Bây giờ bạn có thể cập nhật

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

>>>

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

Khi bạn gọi

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

XÓA BỎ

Cuối cùng nhưng không kém phần quan trọng, nếu bạn muốn loại bỏ hoàn toàn tài nguyên, thì bạn sử dụng

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

>>>

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

Khi bạn gọi

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

XÓA BỎ

Thư viện >>> import requests >>> api_url = "https://jsonplaceholder.typicode.com/todos" >>> todo = {"userId": 1, "title": "Buy milk", "completed": False} >>> response = requests.post(api_url, json=todo) >>> response.json() {'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201} >>> response.status_code 201 4 là một công cụ tuyệt vời để làm việc với API REST và một phần không thể thiếu trong vành đai công cụ Python của bạn. Trong phần tiếp theo, bạn sẽ thay đổi bánh răng và xem xét những gì cần thiết để xây dựng API REST.

Nghỉ ngơi và Python: Xây dựng API

Thiết kế API REST là một chủ đề lớn với nhiều lớp. Như với hầu hết mọi thứ trong công nghệ, có một loạt các ý kiến ​​về cách tiếp cận tốt nhất để xây dựng API. Trong phần này, bạn sẽ xem xét một số bước được đề xuất để theo dõi khi bạn xây dựng API.

Xác định tài nguyên

Bước đầu tiên bạn sẽ thực hiện khi bạn xây dựng API REST là xác định các tài nguyên mà API sẽ quản lý. Nó phổ biến để mô tả các tài nguyên này dưới dạng danh từ số nhiều, như

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/10"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 10, 'title': 'illo est ... aut', 'completed': True}

>>> todo = {"userId": 1, "title": "Wash car", "completed": True}
>>> response = requests.put(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Wash car', 'completed': True, 'id': 10}

>>> response.status_code
200

https://api.github.com/users/

https://api.github.com/users/

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/10"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 10, 'title': 'illo est ... aut', 'completed': True}

>>> todo = {"userId": 1, "title": "Wash car", "completed": True}
>>> response = requests.put(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Wash car', 'completed': True, 'id': 10}

>>> response.status_code
200

https://api.github.com/users/

https://api.github.com/users/

https://api.github.com/users/

https://api.github.com/users/

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

https://api.github.com/users/

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/10"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 10, 'title': 'illo est ... aut', 'completed': True}

>>> todo = {"userId": 1, "title": "Wash car", "completed": True}
>>> response = requests.put(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Wash car', 'completed': True, 'id': 10}

>>> response.status_code
200

https://api.github.com/users/

https://api.github.com/users/

https://api.github.com/users/

https://api.github.com/users/

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

https://api.github.com/users/

Nhận một danh sách các giao dịch.

https://api.github.com/users/

Nhận một giao dịch duy nhất.

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

Tạo một giao dịch mới.

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

https://api.github.com/users/

https://api.github.com/users/

Bây giờ, hãy xem cùng một

https://api.github.com/users/

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

JSON lưu trữ dữ liệu trong các cặp giá trị khóa tương tự như từ điển Python. Giống như XML, JSON hỗ trợ dữ liệu làm tổ ở bất kỳ cấp độ nào, vì vậy bạn có thể mô hình hóa dữ liệu phức tạp.

Cả JSON và XML đều không tốt hơn so với người khác, nhưng có một ưu tiên cho JSON trong số các nhà phát triển API REST. Điều này đặc biệt đúng khi bạn ghép API REST với khung phía trước như React hoặc Vue.

Thiết kế phản ứng thành công

Khi bạn đã chọn định dạng dữ liệu, bước tiếp theo là quyết định cách bạn sẽ trả lời các yêu cầu HTTP. Tất cả các phản hồi từ API REST của bạn sẽ có định dạng tương tự và bao gồm mã trạng thái HTTP thích hợp.

Trong phần này, bạn sẽ xem xét một số câu trả lời HTTP ví dụ cho API giả thuyết quản lý hàng tồn kho của

https://api.github.com/users/

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

Để bắt đầu mọi thứ, hãy xem yêu cầu

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

https://api.github.com/users/

https://api.github.com/users/

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

Yêu cầu HTTP này được tạo thành từ bốn phần:

1. >>> import requests
   >>> api_url = "https://jsonplaceholder.typicode.com/todos"
   >>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
   >>> response = requests.post(api_url, json=todo)
   >>> response.json()
   {'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}
   
   >>> response.status_code
   201
   

   5 là loại phương pháp HTTP. is the HTTP method type.

2. https://api.github.com/users/
   

   46 là điểm cuối API. is the API endpoint.

3. https://api.github.com/users/
   

   50 là phiên bản HTTP. is the HTTP version.

4. https://api.github.com/users/
   

   51 là máy chủ API. is the API host.

Bốn phần này là tất cả những gì bạn cần để gửi yêu cầu

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

https://api.github.com/users/

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

API trả về một phản hồi chứa danh sách

https://api.github.com/users/

https://api.github.com/users/

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

Điều quan trọng là luôn luôn đặt tiêu đề

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

https://api.github.com/users/

Bạn cũng muốn bao gồm một mã trạng thái thích hợp trong phản hồi của bạn. Đối với bất kỳ yêu cầu

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

https://api.github.com/users/

Hãy xem một yêu cầu

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

Yêu cầu HTTP này truy vấn API cho xe

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

Phản hồi này chứa một đối tượng JSON duy nhất với dữ liệu xe hơi. Vì nó là một đối tượng duy nhất, nên nó không cần phải được gói trong danh sách. Giống như phản hồi cuối cùng, điều này cũng có mã trạng thái

https://api.github.com/users/

Tiếp theo, hãy xem yêu cầu

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

Yêu cầu

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

Ở đây, câu trả lời:

https://api.github.com/users/

Phản hồi này có mã trạng thái

https://api.github.com/users/

https://api.github.com/users/

https://api.github.com/users/

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

Phản hồi này cũng bao gồm một bản sao của chiếc xe mới với

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

Bây giờ hãy xem một yêu cầu

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

https://api.github.com/users/

Yêu cầu này sử dụng

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

https://api.github.com/users/

Phản hồi bao gồm một bản sao của

https://api.github.com/users/

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

https://api.github.com/users/

>>> import requests
>>> import json
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> headers =  {"Content-Type":"application/json"}
>>> response = requests.post(api_url, data=json.dumps(todo), headers=headers)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

https://api.github.com/users/

https://api.github.com/users/

https://api.github.com/users/

Phản hồi chứa một bản sao đầy đủ của

https://api.github.com/users/

https://api.github.com/users/

https://api.github.com/users/

Cuối cùng, hãy xem API REST của bạn sẽ phản hồi như thế nào khi nhận được yêu cầu

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

https://api.github.com/users/

Yêu cầu

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

https://api.github.com/users/

https://api.github.com/users/

Phản hồi này chỉ bao gồm mã trạng thái

https://api.github.com/users/

https://api.github.com/users/

Các câu trả lời ở trên hoạt động tốt khi mọi thứ diễn ra theo kế hoạch, nhưng điều gì xảy ra nếu có vấn đề với yêu cầu? Trong phần tiếp theo, bạn sẽ xem xét cách API REST của bạn trả lời khi xảy ra lỗi.

Thiết kế phản hồi lỗi

Luôn luôn có một cơ hội yêu cầu API REST của bạn có thể thất bại. Đó là một ý tưởng tốt để xác định phản hồi lỗi sẽ như thế nào. Những phản hồi này nên bao gồm một mô tả về những gì lỗi xảy ra cùng với mã trạng thái thích hợp. Trong phần này, bạn sẽ xem xét một vài ví dụ.

Để bắt đầu, hãy xem yêu cầu tài nguyên không tồn tại trong API:

https://api.github.com/users/

Tại đây, người dùng gửi yêu cầu

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

https://api.github.com/users/

https://api.github.com/users/

Phản hồi này bao gồm mã trạng thái

https://api.github.com/users/

Bây giờ hãy xem phản hồi lỗi khi người dùng gửi yêu cầu không hợp lệ:

https://api.github.com/users/

Yêu cầu

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

$ python -m pip install requests

https://api.github.com/users/

Phản hồi này bao gồm thông báo lỗi mô tả cùng với mã trạng thái

$ python -m pip install requests

Có một số cách khác mà yêu cầu có thể sai ngay cả khi nó được định dạng đúng. Trong ví dụ tiếp theo này, người dùng gửi yêu cầu

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

https://api.github.com/users/

Trong yêu cầu này, người dùng gửi XML, nhưng API chỉ hỗ trợ JSON. API trả lời với điều này:

$ python -m pip install requests

Phản hồi này bao gồm mã trạng thái

$ python -m pip install requests

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

Trong ví dụ tiếp theo này, người dùng gửi yêu cầu

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

https://api.github.com/users/

$ python -m pip install requests

Trong yêu cầu này, người dùng thêm các trường

$ python -m pip install requests

$ python -m pip install requests

$ python -m pip install requests

Phản hồi này bao gồm mã trạng thái

$ python -m pip install requests

Trả lời các yêu cầu, cả thành công và sai lầm, là một trong những công việc quan trọng nhất của API REST. Nếu API của bạn trực quan và cung cấp các phản hồi chính xác, thì người dùng sẽ dễ dàng xây dựng các ứng dụng xung quanh dịch vụ web của bạn. May mắn thay, một số khung web Python tuyệt vời trừu tượng hóa sự phức tạp của việc xử lý các yêu cầu HTTP và trả lời trả lại. Bạn sẽ xem xét ba tùy chọn phổ biến trong phần tiếp theo.

Bình giữ nhiệt

Flask là một microframework Python được sử dụng để xây dựng các ứng dụng web và API REST. Flask cung cấp một xương sống vững chắc cho các ứng dụng của bạn trong khi để lại nhiều lựa chọn thiết kế tùy thuộc vào bạn. Công việc chính của Flask Flask là xử lý các yêu cầu HTTP và định tuyến chúng đến chức năng thích hợp trong ứng dụng.

Dưới đây là một ứng dụng bình ví dụ cho API REST:

$ python -m pip install requests

Ứng dụng này xác định điểm cuối API

$ python -m pip install requests

1. $ python -m pip install requests
   

   19 Trả về danh sách

   $ python -m pip install requests
   

   17. returns the list of

   $ python -m pip install requests
   

   17.

2. $ python -m pip install requests
   

   21 thêm

   $ python -m pip install requests
   

   22 mới vào danh sách. adds a new

   $ python -m pip install requests
   

   22 to the list.

Bạn có thể dùng thử ứng dụng này bằng cách cài đặt

$ python -m pip install requests

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

$ python -m pip install requests

Khi

$ python -m pip install requests

$ python -m pip install requests

$ python -m pip install requests

$ python -m pip install requests

Chạy lệnh sau bên trong thư mục chứa

$ python -m pip install requests

$ python -m pip install requests

Điều này đặt

$ python -m pip install requests

$ python -m pip install requests

$ python -m pip install requests

$ python -m pip install requests

$ python -m pip install requests

Bên cạnh việc cung cấp thông báo lỗi hữu ích, chế độ gỡ lỗi sẽ kích hoạt tải lại ứng dụng sau khi tất cả các thay đổi mã. Không có chế độ gỡ lỗi, bạn phải khởi động lại máy chủ sau mỗi lần thay đổi.

Với tất cả các biến môi trường đã sẵn sàng, giờ đây bạn có thể khởi động máy chủ phát triển Flask bằng cách gọi

$ python -m pip install requests

$ python -m pip install requests

Điều này bắt đầu một máy chủ chạy ứng dụng. Mở trình duyệt của bạn và truy cập

$ python -m pip install requests

$ python -m pip install requests

Phản hồi JSON này chứa ba

$ python -m pip install requests

$ python -m pip install requests

$ python -m pip install requests

Mã này sử dụng

$ python -m pip install requests

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

$ python -m pip install requests

Trong mã trên,

$ python -m pip install requests

$ python -m pip install requests

$ python -m pip install requests

Bây giờ hãy xem

$ python -m pip install requests

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

$ python -m pip install requests

$ python -m pip install requests

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

Hàm này thực hiện các hoạt động sau:

1. Sử dụng

   $ python -m pip install requests
   

   48 để kiểm tra xem yêu cầu có phải là JSON không
2. Tạo một thể hiện

   $ python -m pip install requests
   

   22 mới với

   $ python -m pip install requests
   

   50
3. Tìm

   from flask import Flask
   from flask_restful import Resource, Api
   
   app = Flask(__name__)
   api = Api(app)
   
   class ExecuteScript:
     def printScript:
       return "Hello World"
   
   api.add_resource(ExecuteScript, '/printScript')
   
   if __name__ == '__main__':
       app.run(debug=True)
   

   62 tiếp theo và đặt nó trên

   $ python -m pip install requests
   

   22
4. Nối thêm

   $ python -m pip install requests
   

   22 mới vào

   $ python -m pip install requests
   

   17
5. Trả lại

   $ python -m pip install requests
   

   22 trong phản hồi cùng với mã trạng thái

   https://api.github.com/users/
   

   71
6. Trả về thông báo lỗi và mã trạng thái

   $ python -m pip install requests
   

   04 nếu yêu cầu không phải là json

$ python -m pip install requests

$ python -m pip install requests

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

$ python -m pip install requests

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

Hàm trợ giúp này sử dụng biểu thức máy phát để chọn tất cả ID quốc gia và sau đó gọi

$ python -m pip install requests

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

Bạn có thể thử điểm cuối này trong shell bằng Curl công cụ dòng lệnh, cho phép bạn gửi các yêu cầu HTTP từ dòng lệnh. Tại đây, bạn sẽ thêm một

$ python -m pip install requests

$ python -m pip install requests

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

Lệnh Curl này có một số tùy chọn hữu ích để biết:

• $ python -m pip install requests
  

  66 Đặt phương thức HTTP cho yêu cầu. sets the HTTP method for the request.

• $ python -m pip install requests
  

  67 thêm một tiêu đề HTTP vào yêu cầu. adds an HTTP header to the request.

• $ python -m pip install requests
  

  68 Xác định dữ liệu yêu cầu. defines the request data.

Với các tùy chọn này được đặt, Curl sẽ gửi dữ liệu JSON theo yêu cầu

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

$ python -m pip install requests

$ python -m pip install requests

Bạn có thể sử dụng Curl để gửi yêu cầu

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

$ python -m pip install requests

$ python -m pip install requests

$ python -m pip install requests

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

Điều này trả về danh sách đầy đủ các quốc gia trong hệ thống, với quốc gia mới nhất ở phía dưới.

Đây chỉ là một mẫu của những gì bình có thể làm. Ứng dụng này có thể được mở rộng để bao gồm các điểm cuối cho tất cả các phương pháp HTTP khác. Flask cũng có một hệ sinh thái lớn của các phần mở rộng cung cấp chức năng bổ sung cho API REST, chẳng hạn như tích hợp cơ sở dữ liệu, xác thực và xử lý nền.

Khung nghỉ ngơi Django

Một lựa chọn phổ biến khác để xây dựng API REST là Django Rest Framework. Django REST Framework là một plugin Django bổ sung chức năng API REST trên đầu một dự án Django hiện có.

Để sử dụng Framework Django Rest, bạn cần một dự án Django để làm việc. Nếu bạn đã có một, thì bạn có thể áp dụng các mẫu trong phần cho dự án của mình. Nếu không, hãy theo dõi và bạn sẽ xây dựng một dự án Django và thêm vào khung Rest Django.

Đầu tiên, cài đặt

$ python -m pip install requests

$ python -m pip install requests

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class ExecuteScript:
  def printScript:
    return "Hello World"

api.add_resource(ExecuteScript, '/printScript')

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

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

Điều này cài đặt

$ python -m pip install requests

$ python -m pip install requests

$ python -m pip install requests

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

Lệnh này tạo một thư mục mới trong thư mục hiện tại của bạn có tên là

$ python -m pip install requests

Để tạo ứng dụng, thay đổi các thư mục thành

$ python -m pip install requests

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

Điều này tạo ra một thư mục

$ python -m pip install requests

Bây giờ bạn đã tạo ra một ứng dụng để làm việc, bạn cần nói với Django về nó. Bên cạnh thư mục

$ python -m pip install requests

$ python -m pip install requests

Mở tệp

$ python -m pip install requests

$ python -m pip install requests

$ python -m pip install requests

$ python -m pip install requests

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

Bạn đã thêm một dòng cho ứng dụng

$ python -m pip install requests

$ python -m pip install requests

Bạn có thể tự hỏi tại sao bạn cần thêm

$ python -m pip install requests

Bước tiếp theo là tạo mô hình Django để xác định các trường dữ liệu của bạn. Bên trong ứng dụng

$ python -m pip install requests

$ python -m pip install requests

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

Mã này xác định mô hình

$ python -m pip install requests

Chạy các lệnh sau để cập nhật cơ sở dữ liệu Django dựa trên mô hình này:

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

Các lệnh này sử dụng di chuyển Django để tạo một bảng mới trong cơ sở dữ liệu.

Bảng này bắt đầu trống, nhưng thật tuyệt khi có một số dữ liệu ban đầu để bạn có thể kiểm tra khung Rest Django. Để làm điều này, bạn sẽ sử dụng một bộ đồ Django để tải một số dữ liệu trong cơ sở dữ liệu.

Sao chép và lưu dữ liệu JSON sau vào một tệp có tên

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

$ python -m pip install requests

>>> response.status_code
200

>>> response.headers["Content-Type"]
'application/json; charset=utf-8'

JSON này chứa các mục cơ sở dữ liệu cho ba quốc gia. Gọi lệnh sau để tải dữ liệu này trong cơ sở dữ liệu:

>>> response.status_code
200

>>> response.headers["Content-Type"]
'application/json; charset=utf-8'

Điều này thêm ba hàng vào cơ sở dữ liệu.

Với điều đó, ứng dụng Django của bạn được thiết lập và điền với một số dữ liệu. Bây giờ bạn có thể bắt đầu thêm Framework Django Rest vào dự án.

Django Rest Framework lấy một mô hình Django hiện có và chuyển đổi nó thành JSON cho API REST. Nó làm điều này với các serializer mô hình. Một bộ tuần tự mô hình cho Django REST Framework cách chuyển đổi một thể hiện mô hình thành JSON và dữ liệu nào sẽ bao gồm.model serializers. A model serializer tells Django REST framework how to convert a model instance into JSON and what data to include.

Bạn có thể tạo bộ tuần tự của mình cho mô hình

$ python -m pip install requests

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

$ python -m pip install requests

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

>>> response.status_code
200

>>> response.headers["Content-Type"]
'application/json; charset=utf-8'

Bộ tuần tự này,

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

$ python -m pip install requests

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

Giống như Django, Django Rest Framework sử dụng các chế độ xem để truy vấn dữ liệu từ cơ sở dữ liệu để hiển thị cho người dùng. Thay vì viết các chế độ xem API REST từ đầu, bạn có thể phân lớp Django REST Framework, lớp

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

Dưới đây, một danh sách các hành động mà

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos/1"
>>> response = requests.get(api_url)
>>> response.json()
{'userId': 1, 'id': 1, 'title': 'delectus aut autem', 'completed': False}

>>> import requests
>>> api_url = "https://jsonplaceholder.typicode.com/todos"
>>> todo = {"userId": 1, "title": "Buy milk", "completed": False}
>>> response = requests.post(api_url, json=todo)
>>> response.json()
{'userId': 1, 'title': 'Buy milk', 'completed': False, 'id': 201}

>>> response.status_code
201