Hướng dẫn rest api in python w3schools - phần còn lại api trong python w3schools

Tạo API đầu tiên

Một tệp fastapi cơ bản trông như thế này:

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Sao chép mã ở trên vào một tệp có tên

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [28720]
INFO:     Started server process [28722]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

Mã này xác định ứng dụng của bạn, nhưng nó đã giành được tự chạy nếu bạn gọi trực tiếp với

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [28720]
INFO:     Started server process [28722]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

Chạy ứng dụng API đầu tiên với Uvicorn

Chạy máy chủ trực tiếp bằng Uvicorn:

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [28720]
INFO:     Started server process [28722]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

Dòng được tô sáng trong đầu ra cho thấy URL nơi ứng dụng của bạn đang được phục vụ trong máy cục bộ của bạn. Vì bạn đã sử dụng

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [28720]
INFO:     Started server process [28722]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

Kiểm tra phản hồi

Mở trình duyệt của bạn đến

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [28720]
INFO:     Started server process [28722]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

{"message": "Hello World"}

Thông báo JSON đó là cùng một từ điển mà bạn đã trả lại từ chức năng trong ứng dụng của mình. Fastapi chăm sóc việc tuần tự hóa Python

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [28720]
INFO:     Started server process [28722]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [28720]
INFO:     Started server process [28722]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

Kiểm tra tài liệu API tương tác

Bây giờ mở

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [28720]
INFO:     Started server process [28722]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

Bạn sẽ thấy tài liệu API tương tác tự động được cung cấp bởi Swagger UI:

Giao diện người dùng dựa trên trình duyệt ghi lại API của bạn được cung cấp và tích hợp theo mặc định. Bạn không cần phải làm bất cứ điều gì khác để tận dụng nó với Fastapi.

Kiểm tra tài liệu API tương tác thay thế

Bây giờ, hãy truy cập

{"message": "Hello World"}

Bạn sẽ thấy tài liệu tự động thay thế được cung cấp bởi Redoc:

Vì Fastapi dựa trên các tiêu chuẩn như Openapi, có nhiều cách khác để hiển thị tài liệu API. Fastapi cung cấp hai lựa chọn thay thế này theo mặc định.

API đầu tiên, từng bước

Bây giờ, hãy để phân tích mã đó từng bước và hiểu những gì mỗi phần làm.

Bước 1 là nhập

{"message": "Hello World"}

{"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

{"message": "Hello World"}

Bước 2 là tạo một thể hiện

{"message": "Hello World"}

{"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Ở đây biến

{"message": "Hello World"}

{"message": "Hello World"}

{"message": "Hello World"}

{"message": "Hello World"}

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

Trước khi tiếp tục với Bước 3, nó đáng để dành một chút thời gian để làm quen với một vài điều khoản. Đường dẫn đề cập đến phần cuối của URL bắt đầu từ ký tự chém đầu tiên (

{"message": "Hello World"}

{"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

{"message": "Hello World"}

{"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Một đường dẫn cũng thường được gọi là điểm cuối hoặc một tuyến đường, nhưng đường dẫn thuật ngữ sẽ được sử dụng trong hướng dẫn này. Khi bạn xây dựng một API, đường dẫn là cách chính bạn có thể tách tài nguyên.endpoint or a route, but the term path will be used in this tutorial. When you’re building an API, the path is the main way you can separate resources.

Một thuật ngữ quan trọng khác cần biết là hoạt động, được sử dụng để tham khảo bất kỳ phương thức yêu cầu HTTP nào:operation, which is used in reference to any of the HTTP request methods:

• # main.py
  
  from fastapi import FastAPI
  
  app = FastAPI()
  
  @app.get("/")
  async def root():
      return {"message": "Hello World"}
  

  1

• # main.py
  
  from fastapi import FastAPI
  
  app = FastAPI()
  
  @app.get("/")
  async def root():
      return {"message": "Hello World"}
  

  2

• # main.py
  
  from fastapi import FastAPI
  
  app = FastAPI()
  
  @app.get("/")
  async def root():
      return {"message": "Hello World"}
  

  3

• # main.py
  
  from fastapi import FastAPI
  
  app = FastAPI()
  
  @app.get("/")
  async def root():
      return {"message": "Hello World"}
  

  4

• # main.py
  
  from fastapi import FastAPI
  
  app = FastAPI()
  
  @app.get("/")
  async def root():
      return {"message": "Hello World"}
  

  5

• # main.py
  
  from fastapi import FastAPI
  
  app = FastAPI()
  
  @app.get("/")
  async def root():
      return {"message": "Hello World"}
  

  6

• # main.py
  
  from fastapi import FastAPI
  
  app = FastAPI()
  
  @app.get("/")
  async def root():
      return {"message": "Hello World"}
  

  7

• # main.py
  
  from fastapi import FastAPI
  
  app = FastAPI()
  
  @app.get("/")
  async def root():
      return {"message": "Hello World"}
  

  8

Với HTTP, bạn có thể giao tiếp với từng đường dẫn bằng một (hoặc nhiều) các hoạt động này. Biết hai thuật ngữ đó có nghĩa là gì, bạn đã sẵn sàng tiếp tục với bước ba.

Bước 3 là xác định một công cụ trang trí hoạt động đường dẫn: is to define a path operation decorator:

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

{"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Bạn cũng có thể sử dụng các hoạt động khác được đề cập ở trên:

• # main.py
  
  from fastapi import FastAPI
  
  app = FastAPI()
  
  @app.get("/")
  async def root():
      return {"message": "Hello World"}
  

  2

• # main.py
  
  from fastapi import FastAPI
  
  app = FastAPI()
  
  @app.get("/")
  async def root():
      return {"message": "Hello World"}
  

  3

• # main.py
  
  from fastapi import FastAPI
  
  app = FastAPI()
  
  @app.get("/")
  async def root():
      return {"message": "Hello World"}
  

  4

• # main.py
  
  from fastapi import FastAPI
  
  app = FastAPI()
  
  @app.get("/")
  async def root():
      return {"message": "Hello World"}
  

  5

• # main.py
  
  from fastapi import FastAPI
  
  app = FastAPI()
  
  @app.get("/")
  async def root():
      return {"message": "Hello World"}
  

  6

• # main.py
  
  from fastapi import FastAPI
  
  app = FastAPI()
  
  @app.get("/")
  async def root():
      return {"message": "Hello World"}
  

  7

• # main.py
  
  from fastapi import FastAPI
  
  app = FastAPI()
  
  @app.get("/")
  async def root():
      return {"message": "Hello World"}
  

  8

Trong mỗi trường hợp, bạn sẽ sử dụng bộ trang trí hoạt động đường dẫn thích hợp phía trên một chức năng chịu trách nhiệm xử lý các yêu cầu đó.

Bước 4 là xác định chức năng hoạt động đường dẫn hoặc chức năng bên dưới trình trang trí hoạt động đường dẫn: is to define the path operation function, or the function that goes below the path operation decorator:

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Hàm này sẽ được Fastapi gọi bất cứ khi nào nhận được yêu cầu đến URL được chỉ định (

{"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

Bạn cũng có thể định nghĩa nó là một hàm bình thường thay vì sử dụng

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def root():
    return {"message": "Hello World"}

Nếu bạn không biết sự khác biệt giữa các hàm bình thường và các chức năng

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

Bước 5 là trả về nội dung: is to return the content:

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Bạn có thể trả về một từ điển, danh sách hoặc giá trị số ít như chuỗi, số nguyên, v.v. Bạn cũng có thể trả lại các mô hình Pydantic, mà bạn sẽ tìm hiểu thêm về sau này.

Có nhiều đối tượng và mô hình khác sẽ được tự động chuyển đổi thành JSON, bao gồm các máy lập liên quan đến đối tượng (ORM) và các đối tượng khác. Hãy thử sử dụng những cái yêu thích của bạn, nó rất có thể có khả năng mà chúng đã được hỗ trợ.

Tham số đường dẫn với các loại

Bạn có thể khai báo loại tham số đường dẫn trong hàm bằng Gợi ý loại Python tiêu chuẩn:

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Trong trường hợp này, bạn tuyên bố

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Khai báo loại tham số đường dẫn sẽ cung cấp cho bạn hỗ trợ Trình chỉnh sửa bên trong chức năng của bạn, với kiểm tra lỗi, hoàn thành, v.v.

Chuyển đổi dữ liệu

Nếu bạn chạy ví dụ trên và điều hướng trình duyệt của bạn đến

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Lưu ý rằng giá trị mà chức năng của bạn nhận được và sau đó được trả về là

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Xác nhận dữ liệu

Nếu bạn trỏ trình duyệt của mình đến

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Điều này là do tham số đường dẫn

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Lỗi tương tự sẽ xuất hiện nếu bạn cung cấp

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Cũng lưu ý rằng lỗi nêu rõ điểm chính xác nơi xác thực đã không vượt qua. Điều này cực kỳ hữu ích trong khi phát triển và gỡ lỗi mã tương tác với API của bạn.

Tài liệu

Khi bạn mở trình duyệt của mình tại

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [28720]
INFO:     Started server process [28722]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

Một lần nữa, với cùng một khai báo loại Python, Fastapi cung cấp cho bạn tài liệu tương tác tự động, tích hợp UI Swagger. Lưu ý rằng tham số đường dẫn được khai báo là một số nguyên.

Bởi vì Fastapi được xây dựng trên đỉnh của tiêu chuẩn Openapi, nó cũng cung cấp một tài liệu API thay thế bằng cách sử dụng Redoc, bạn có thể truy cập vào lúc

{"message": "Hello World"}

Có nhiều công cụ tương thích khác, bao gồm các công cụ tạo mã cho nhiều ngôn ngữ.

Xử lý dữ liệu với Pydantic

Tất cả các xác thực dữ liệu được thực hiện dưới mui xe bởi Pydantic, vì vậy bạn nhận được tất cả các lợi ích từ nó và bạn biết bạn đang ở trong tay tốt.

Bạn có thể sử dụng cùng một khai báo loại với

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Vấn đề đặt hàng: Đặt đường dẫn cố định lên hàng đầu

Khi tạo các hoạt động đường dẫn, bạn có thể tìm thấy các tình huống mà bạn có một đường dẫn cố định, như

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Bởi vì các hoạt động đường dẫn được đánh giá theo thứ tự, bạn cần đảm bảo rằng đường dẫn cho

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Mặt khác, đường dẫn cho

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def root():
    return {"message": "Hello World"}

Sử dụng Pydantic để khai báo các mô hình dữ liệu JSON (hình dạng dữ liệu)

Đầu tiên, bạn cần nhập

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def root():
    return {"message": "Hello World"}

Tiếp theo, bạn khai báo mô hình dữ liệu của mình dưới dạng một lớp kế thừa từ

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Khi một thuộc tính mô hình có giá trị mặc định, nó không bắt buộc. Nếu không, nó được yêu cầu. Để tạo thuộc tính tùy chọn, bạn có thể sử dụng

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def root():
    return {"message": "Hello World"}

Ví dụ: mô hình trên tuyên bố một đối tượng JSON (hoặc Python

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [28720]
INFO:     Started server process [28722]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Trong trường hợp này, vì

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Một đối tượng JSON bỏ qua các giá trị mặc định cũng hợp lệ.

Tiếp theo, thêm mô hình Pydantic mới vào hoạt động đường dẫn của bạn dưới dạng tham số. Bạn tuyên bố nó giống như cách bạn khai báo tham số đường dẫn:

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Tham số

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Với tuyên bố loại Python đó, Fastapi sẽ:

• Đọc phần thân của yêu cầu là JSON
• Chuyển đổi các loại tương ứng nếu cần
• Xác thực dữ liệu và trả về một lỗi rõ ràng nếu nó không hợp lệ
• Cung cấp cho bạn dữ liệu nhận được trong tham số ________ 103 vì bạn đã tuyên bố nó là loại

  # main.py
  
  from fastapi import FastAPI
  
  app = FastAPI()
  
  @app.get("/")
  async def root():
      return {"message": "Hello World"}
  

  04, bạn cũng sẽ có tất cả các hỗ trợ của trình soạn thảo, với việc hoàn thành và kiểm tra loại cho tất cả các thuộc tính và loại của chúng
• Tạo định nghĩa lược đồ JSON cho mô hình của bạn mà bạn cũng có thể sử dụng bất cứ nơi nào khác có ý nghĩa cho dự án của bạn

Bằng cách sử dụng gợi ý loại tiêu chuẩn với Pydantic, Fastapi giúp bạn xây dựng API có tất cả các thực tiễn tốt nhất này theo mặc định, với rất ít nỗ lực.

Tài liệu tự động với Pydantic

Các lược đồ JSON của các mô hình Pydantic của bạn sẽ là một phần của Openapi được tạo cho ứng dụng của bạn và sẽ được hiển thị trong tài liệu API tương tác:

Bạn có thể thấy rằng các thuộc tính của

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Các lược đồ JSON này cũng sẽ được sử dụng trong tài liệu API bên trong mỗi thao tác đường dẫn cần chúng:

Lưu ý rằng tất cả tài liệu tự động này dựa trên dữ liệu của bạn, sử dụng các mô hình Pydantic của bạn.

Hỗ trợ biên tập, tự động hoàn thành và kiểm tra loại

Trong trình soạn thảo của bạn, bên trong chức năng của bạn, bạn sẽ nhận được gợi ý loại và hoàn thành ở mọi nơi. Điều này sẽ xảy ra nếu bạn nhận được

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [28720]
INFO:     Started server process [28722]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

Bằng cách này, bạn có thể kích hoạt tự động hoàn thành cho tất cả dữ liệu của mình.

Bạn cũng nhận được kiểm tra lỗi cho các hoạt động loại không chính xác:

Trong trường hợp này, bạn không thể tổng hợp

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Các ảnh chụp màn hình trước đó được chụp với mã Visual Studio. Nhưng bạn sẽ nhận được cùng một hỗ trợ biên tập viên với Pycharm và hầu hết các biên tập viên Python khác:

Nếu bạn sử dụng Pycharm làm trình chỉnh sửa của mình, thì bạn có thể sử dụng plugin Pycharm Pydantic để cải thiện hỗ trợ trình soạn thảo của bạn. Và nếu bạn sử dụng mã VS, thì bạn sẽ có được trải nghiệm phát triển tốt nhất với Pylance.

Sử dụng mô hình Pydantic

Bên trong hàm, bạn có thể truy cập trực tiếp tất cả các thuộc tính của đối tượng mô hình:

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Tham số

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Yêu cầu các thông số cơ thể và đường dẫn

Bạn có thể khai báo tham số đường dẫn và thân yêu cầu cùng một lúc.

Fastapi sẽ nhận ra rằng các tham số hàm khớp với các tham số đường dẫn nên được lấy từ đường dẫn và các tham số hàm được tuyên bố là các mô hình Pydantic nên được lấy từ thân yêu cầu:

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [28720]
INFO:     Started server process [28722]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

Bằng cách này, bạn có thể khai báo các tham số đường dẫn và các cơ quan yêu cầu JSON và Fastapi sẽ chăm sóc tất cả các xác thực dữ liệu, tuần tự hóa và tài liệu cho bạn. Bạn có thể xác minh nó bằng cách truy cập cùng một tài liệu API tại

# main.py

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

Theo cách tương tự, bạn có thể khai báo các cơ quan yêu cầu phức tạp hơn, như danh sách và các loại dữ liệu yêu cầu khác, như tham số truy vấn, cookie, tiêu đề, đầu vào hình thức, tệp, v.v.