Hướng dẫn python api parameters - tham số api python
Lời mở đầuChào các bạn, hôm nay tôi xin giới thiệu với các bạn về 1 framework API mà tôi mới vọc vạch mấy tuần trước. Tại sao tôi lại giới thiệu framework này, âu cũng là do cái slogan của team này bắt mắt quá . . Show
Vậy fastAPI là gì, mời các bạn đọc phần tiếp theo. Khái niệmFastApi là 1 web framework dùng để build API có hiệu năng cao, code dễ ẹc, đơn giản nhưng cũng hỗ trợ tốt cho việc làm sản phẩm. Đặc điểm:
Cài đặtYêu cầu: Python 3.6+. FastAPI được build dựa trên OpenAPI (trước có tên Swagger), phần web được support bởi Starlette, còn phần data được support bởi Pydantic. FastAPI CLIĐể cài đặt framework này trên Ubuntu, bạn cần phiên bản python ≥\geq 3.6.≥\geq 3.6.
Bạn cũng cần ASGI server khi deploy sản phẩm như Uvicorn hoặc Hypercorn.
Nói sơ qua về ASGI 1 chút, ASGI kế thừa từ WSGI. Mà WSGI là 1 chuẩn giao tiếp giữa web server và Python application server. Trước thì có mod_python của Apache nhưng do không phát triển và không an toàn nên WSGI sinh ra. WSGI có những tác dụng như sau:
Nếu như WSGI là tiêu chuẩn cho các 8thì ASGI là tiêu chuẩn cho cả 9 và 0 1. ASGI phù hợp với tất cả ứng dụng sử dụng WSGI do có cơ chế tương thích ngược.Ok dông dài đủ rồi, chúng ta tiếp tục tìm hiểu xem FastAPI còn cung cấp những tiện ích gì nhé. FastAPI DocsDo based trên OpenAI mà trước đó có tên là Swagger nên FastAPI cung cấp doc có giao diện dễ nhìn, dễ sử dụng. Ví dụ minh họa: Khi bật doc bằng local url 2. 1 giao diện khác của FastAPI docs 3. PerformanceCác bạn có thể test hiệu năng của các web framework trên trang này (https://www.techempower.com/benchmarks/) Optional DepenciesDo FastAPI based trên Pydantic và Starlette nên có hỗ trợ thêm 1 số thư viện có cũng được không có cũng không sao: Pydantic:
Starlette:
FastAPI:
Nếu muốn dùng hết thư viện trên thì bạn chỉ cần dùng 1 câu lệnh đơn giản.
Hướng dẫn cơ bảnCreate a simple APIVề cơ bản thì code dễ như ăn kẹo, bạn tạo 1 file 0.
Sau đó chạy dòng code này để chạy app
P/S: nếu bạn làm trong môi trường phát triển có thể thêm 1 để tự động restart sau khi thay đổi code.Tiếp sau đó vào xem thử thành quả phát 2. Ấn vào 3 -> 4 -> API trả về response.
Giao diện API này được thiết kế dựa trên OpenAPI. Bên đó có hẳn 1 khái niệm để define API gọi là "Schema". Nếu bạn tò mò thì vào link này 5.
Nói chung bạn chỉ cần 6 bước để tạo 1 API
Path ParametersBạn có thể truyền param thông qua đường dẫn.
Biến 7 trên đường dẫn sẽ truyền vào hàm read_item với thông qua param trùng tên 7. Test thử 9.Path parameters with typesBạn cũng có thể khai báo định dạng của param để trả về khi truyền biến đúng định dạng sẽ trả về giá trị.
Data validationCòn nếu không đúng định dạng thì trả về thông báo. Mọi dữ liệu được validate đều dựa trên Pydantic. OrderNếu bạn có khai báo đường dẫn trùng lặp như thế này:
Thì nhớ để theo thứ tự 0 trước rồi đến 1 sau, ngược lại nếu 1 ở trước thì sẽ nghĩ rằng "user_id" được nhận giá trị 3.Path in pathFastAPI hỗ trợ khai báo đường dẫn trong đường dẫn API nhờ vào việc based Starlette.
0Query ParametersNếu bạn truyền param dưới dạng key-value thì ở trong FastAPI có hỗ trợ với tên gọi "query" parameters. 1Kiểm tra ở link 4: Nếu bạn để ý skip và limit có format string khi làm đường dẫn nhưng một khi truyền về hàm thì sẽ ngay lập tức được convert từ string về int. Optional parametersNgoài ra FastAPI cung cấp một cách khai báo 5 query parameters, mặc định là None. 2Như bạn thấy ở trên param truyền ở đường dẫn là 7, nhưng trong hàm có thêm param 7. FastAPI chỉ sử dụng 8 để nhận định format của param còn 9 thì FastAPI không sử dụng, chỉ có tác dụng check lỗi nếu xảy ra.Bạn có thể test bằng đường dẫn sau. 3Query parameter type conversionThay đổi giá trị mặc định bằng cách truyền giá trị trên đường dẫn. 4Trong trường hợp này 5Multiple path and query parametersVới các đường dẫn lồng nhau, FastAPI biết param nào với param nào dựa trên tên param. 6Required query parametersĐơn giản là bạn điền thiếu param trên đường dẫn sẽ báo lỗi 7Như hình dưới này, tôi chỉ truyền vào giá trị của 7 còn giá trị của 1 thì không nên sinh ra lỗi. Request Body
Để khai báo format của request body, bạn cần sử dụng 2 models. P/S: nhắc nhở khi send request cần sử dụng phương thức POST, nếu dùng phương thức GET thì bạn sẽ bị lộ thông tin trên URL => tính bảo mật không cao.Pydantic Models 8Ví dụ về 1 instance của class Item. 9Do 3 và 4 có giá trị None nên bạn có thể không cần thêm vào cũng được. 0Dựa trên việc import Pydantic module, FastAPI hỗ trợ:
Use modelTrong hàm create_item, bạn có thể tùy biến các biến của class Item, đơn giản như việc tính phí chịu thuế bằng cách tính tổng 5 và 6 như bên dưới. 1Request body + path parametersFastAPI hỗ trợ khai báo tham số URL và request body cùng lúc, framework sẽ biết tham số nào truyền từ đường dẫn và tham số nào lấy từ request. 2P/S: tương tự như trên bạn có thể thêm tham số URL, tham số query và request body cùng lúc. Query Parameters and String ValidationsỞ phần trước chúng ta đã biết khái niệm của query parameter rồi, lạ 1 loại param có cũng được không có cũng không sao. Param này có attribute là 9, nhưng độ dài bị giới hạn không vượt quá 50 ký tự. Nên FastAPI cung cấp class Query. 3Câu lệnh 8 cũng tương tự 9 nhưng Query cung cấp các param khác như max_lenght, min_lenght, regex, ... Bạn có thể tăng giới hạn ký tự thành 250 như thế này chỉ việc thay đổi giá trị tham số. (Mặc định của max_lenght là 50) 4Query parameter list / multiple valuesNgoài định dạng string và integer, FastAPI còn hỗ trợ type List. 5 6Response body mà API trả về. 7API cũng được cập nhật theo. P/S: bạn cũng có thể thay 00 thành 01 như thế này. P/S:
bạn cũng có thể thay 00 thành 01 như thế này. 8Query còn 1 vài param nữa nhưng không quá quan trọng, bạn có thể vào doc của FastAPI để tìm hiểu chi tiết. Các param mà Query cung cấp: Metadata
Validation cho string:
Path Parameters and Numeric ValidationsQuery parameters có class Query để khai báo metadata và validations, Path parameters có class Pass với cơ chế tương tự. Thêm 03 metadata cho path param 7: 9Number validations: greater than or equalChúng ta không chỉ có thể validate string mà còn validate được number. Với param 11 của class Path, 7 bắt buộc phải là 1 số lớn hơn hoặc bằng 1 0Number validations: greater than and less than or equalTương tự với 13, 7 bắt buộc phải là 1 số nhỏ hơn hoặc bằng 100. 1P/S: Number validations không chỉ hỗ trợ type integer mà còn hỗ trợ cho type float. 2
BodyMultiple ParametersĐơn giản là FastAPI hỗ trợ tạo format cho request body, bạn có thể dùng không chỉ 1 mà là N Pydantic model như ví dụ dưới, tôi khai báo 2 class 19 và 20 tương ứng 2 Pydantic model. 3 4Singular values in bodyBạn cũng có thể thêm define 1 body cho chỉ 1 giá trị mà không cần khai báo class, giả dụ ở đây tôi thêm 1 param là 21 có type là int và cũng là 1 key nằm trong json body, nên khi post data thì bạn cũng phải khai báo giá trị cho 21. 5 6Multiple body params and queryNói đơn giản là kết hợp multiple body param với query param. 7FieldĐể validate data hoặc thêm metadata trong 1 class giả dụ 19 chẳng hạn, bạn cần import 24 operation function từ module 25. 8Như đoạn code ở trên param 3 có metadata là title, với length không vượt quá 300 từ, hay như param 27 không được nhỏ hơn 0 và có metadata là description.Nested ModelsNgoài các kiểu int, float, str, bạn còn có thể thêm kiểu list hay set như dưới đây. 9Với cách khai báo trên, khi post bạn truyền param là 1 list, nhưng với cách khai báo trên thì list này sẽ không xác định kiểu định dạng của từng phần tử trong list. Không sao bởi Python có module 28 hỗ trợ bạn khai báo param là list xác định kiểu định dạng của từng phần tử. 0Tương tự với 28, bạn có thể thêm 30. 1Ngoài ra các kiểu normal như str, int, float, ... FastAPI cũng hỗ trợ thêm các định dạng phức tạp và đa dạng hơn, giả sử định dạng 31 kế thừa từ định dạng 8. Để biết thêm chi tiết mời check link này (https://pydantic-docs.helpmanual.io/usage/types/).
Giả sử tôi có 2 class Images và Item. 2Tôi muốn class Images nằm trong class Item như thế này. 3Bạn chỉ cần thêm 1 dòng code vào class Item. Easy ! 4Bạn cũng có thể tùy biến định dạng của Pydantic models là list hoặc set chẳng hạn. 5Và đây là kết quả. 6Trên lý thuyết bạn có thể lặp đi lặp lại các models lồng nhau như sau. Class Image nằm trong class Item, class Item thì lại nằm trong class Offer. 7Kết luậnDo FastAPI là 1 framework API mới, có rất nhiều tính năng nên tôi chia ra thành nhiều phần (căn bản do không đủ kiên nhẫn để viết ). Ở đây tôi sẽ chỉ liệt kê các tính năng quan trọng dùng nhiều trước rồi sau đó sẽ nâng cao lên trong các phần tiếp theo. Bạn cũng có thể xem thẳng trên doc của fastapi. Link tham khảo here: ). Ở đây tôi sẽ chỉ liệt kê các tính năng quan trọng dùng nhiều trước rồi sau đó sẽ nâng cao lên trong các phần tiếp theo. Bạn cũng có thể xem thẳng trên doc của fastapi. Link tham khảo here:
|