{"id":8936,"date":"2023-09-13T01:38:56","date_gmt":"2023-09-12T17:38:56","guid":{"rendered":"\/?p=8936"},"modified":"2023-09-13T01:38:56","modified_gmt":"2023-09-12T17:38:56","slug":"fastapi%e5%9f%ba%e7%a1%80%ef%bc%9a4-%e5%93%8d%e5%ba%94%e6%a8%a1%e5%9e%8b","status":"publish","type":"post","link":"\/?p=8936","title":{"rendered":"FastAPI\u57fa\u7840\uff1a4.\u54cd\u5e94\u6a21\u578b"},"content":{"rendered":"

\u5b98\u65b9\u6587\u6863\uff1a\u54cd\u5e94\u6a21\u578b - FastAPI (tiangolo.com)<\/a><\/p>\n

"""\nresponse_model \u4f5c\u7528\n1. \u9650\u5236\u8fd4\u56de\u6570\u636e\uff0c\u4ec5\u663e\u793a\u6a21\u578b\u9700\u8981\u7684\u5b57\u6bb5\uff08\n\u5982\u679c\u5fc5\u8981\uff0c\u4f46\u662f\u6ca1\u6709\u5219\u62a5\u9519\uff0c\u5982\u679c\u6709\u591a\u4f59\uff0c\u5219\u7701\u7565\u6389\uff09\uff1b\n\u4e0d\u4f1a\u51cf\u5c11db\u5c42\u8017\u65f6\n2. \u63a5\u53e3\u6587\u6863\u751f\u6210 schema\n"""<\/code><\/pre>\n
\u54cd\u5e94\u6a21\u578b<\/h2>\n
from pydantic import BaseModel\nfrom typing import Optional\n\nclass User(BaseModel):\n    username: str\n    password: str\n    id: Optional[int]\n\n"""\nresponse_model \u4f5c\u7528\n1. \u9650\u5236\u8fd4\u56de\u6570\u636e\uff0c\u4ec5\u663e\u793a\u6a21\u578b\u9700\u8981\u7684\u5b57\u6bb5\uff08\u5982\u679c\u5fc5\u8981\uff0c\u4f46\u662f\u6ca1\u6709\u5219\u62a5\u9519\uff0c\u5982\u679c\u6709\u591a\u4f59\uff0c\u5219\u7701\u7565\u6389\uff09\uff1b\u4e0d\u56de\u51cf\u5c11db\u5c42\u8017\u65f6\n2. \u63a5\u53e3\u6587\u6863\u751f\u6210 schema\n"""\n\n@app.get("\/r", response_model=User)\nasync def r():\n    return User(username="age", password="123", id=100)\n\n@app.get("\/r2", response_model=User)\nasync def r2():\n    # \u8fd4\u56de\u6570\u636e {\n    #   "username": "age",\n    #   "password": "123",\n    #   "id": null\n    # }\n    return {"username": "age", "password": "123", "kk": "age"}\n\n# \u6392\u9664\u5b57\u6bb5 \u7528\u7684\u4e0d\u591a\u57fa\u672c\u5728\u5b9a\u4e49pydanitc model \u7684\u65f6\u5019\u5c31\u5ffd\u7565\u4e86\n@app.get("\/r1", response_model=User,\n         response_model_exclude_unset=True,  # \u6392\u9664\u8fd4\u56de\u6570\u636e\u5305\u542b\u9ed8\u8ba4\u503c\u7684\n         response_model_include={"username"},  # \u5305\u542b\u5b57\u6bb5\n         response_model_exclude={"password", },  # \u6392\u9664\u5b57\u6bb5\n         )\nasync def r1():\n    user = User(username="age", password="123")\n    # \u6700\u7ec8\u8fd4\u56de {"username": "age"}\n    return user\n<\/code><\/pre>\n
\u901a\u7528\u54cd\u5e94\u6a21\u578b<\/h2>\n
ps: \u901a\u5e38\u9879\u76ee\u4e2d\u6211\u4eec\u4e0d\u4f1a\u76f4\u63a5\u8fd4\u56de\u6570\u636e\uff0c\u800c\u662f\u66f4\u591a\u7684\u4f7f\u7528\u4e0b\u9762\u7684\u5f62\u5f0f<\/p>\n
{\n  "code": 400,    # \u4e1a\u52a1code\n  "msg": "sss", # \u4e1a\u52a1msg\n  "data": null # \u5b9e\u9645\u7684\u6570\u636e\n}<\/code><\/pre>\n
\u53e6\u4e00\u65b9\u9762\u901a\u8fc7\u8fd9\u7c7b\u6a21\u578b\u53ef\u4ee5\u5b9e\u73b0\u4e0d\u540cdata\u7c7b\u578b\u751f\u6210\u7684 \u63a5\u53e3\u6587\u6863\u4e0d\u4e00\u81f4<\/p>\n
from pydantic import BaseModel\n\nfrom typing import TypeVar, Generic\nfrom pydantic.generics import GenericModel\n\nclass User(BaseModel):\n    username: str\n    password: str\n    id: Optional[int]\n\nclass Role(BaseModel):\n    rid: int\n    role: str\n    user: User\n\n# \u6cdb\u578b\u7c7b\u578b\nT = TypeVar('T')\n\n"""\nhttps:\/\/pydantic-docs.helpmanual.io\/usage\/models\/#generic-models\n"""\nfrom enum import IntEnum\n\n# \u4e1a\u52a1code\nclass StatusCodeEnums(IntEnum):\n    # \u6210\u529f\n    SUCCESS: int = 20000\n    # \u521b\u5efa\u6210\u529f\n    CREATE_SUCCESS: int = 20001\n    # \u5220\u9664\u6210\u529f\n    DELETE_SUCCESS: int = 20004\n\n    # \u8eab\u4efd\u9a8c\u8bc1\u5931\u8d25\n    UNAUTHORIZED: int = 40001\n\n    # \u670d\u52a1\u5668\u9519\u8bef\n    ERROR: int = 50000\n\n# \u901a\u7528\u54cd\u5e94\u6a21\u578b\uff1b Generic[T] \u6cdb\u578b\u7c7b\nclass R(GenericModel, Generic[T]):\n    code: int\n    msg: str\n    # \u8868\u793adata\u53ef\u4ee5\u4e3aNone\uff0c \u6216\u8005\u5c31\u662fT\u7c7b\u578b -> \u4f7f\u7528\u65f6\u51b3\u5b9a\u5bf9\u5e94\u7c7b\u578b R[T]\n    data: Optional[T] \n\n    @staticmethod\n    def success(data: Optional[T] = None, msg: str = "ok"):\n        return R(code=StatusCodeEnums.ERROR, msg=msg, data=data)\n\n    @staticmethod\n    def fail(msg: Optional[str] = "\u5931\u8d25", data: Optional[T] = None):\n        return R(code=400, msg=msg, data=data)\n\n@app.get("\/ok", response_model=R[User])\nasync def ok():\n    return R.success(data=User(username="111", password="123"))\n\n@app.get("\/fail", response_model=R[Role])\nasync def fail():\n    return R.fail("sss")<\/code><\/pre>\n
user schema<\/h3>\n
class User(BaseModel):\n    username: str\n    password: str\n    id: Optional[int]<\/code><\/pre>\n
\"image.png\"<\/p>\n
role schema<\/h3>\n
class Role(BaseModel):\n    rid: int\n    role: str\n    user: User<\/code><\/pre>\n
\"image.png\"<\/p>\n","protected":false},"excerpt":{"rendered":"
\u5b98\u65b9\u6587\u6863\uff1a\u54cd\u5e94\u6a21\u578b – FastAPI (tiangolo.com) """ response_model   \u2026 …<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"ngg_post_thumbnail":0},"categories":[204],"tags":[116],"_links":{"self":[{"href":"\/index.php?rest_route=\/wp\/v2\/posts\/8936"}],"collection":[{"href":"\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=8936"}],"version-history":[{"count":1,"href":"\/index.php?rest_route=\/wp\/v2\/posts\/8936\/revisions"}],"predecessor-version":[{"id":8937,"href":"\/index.php?rest_route=\/wp\/v2\/posts\/8936\/revisions\/8937"}],"wp:attachment":[{"href":"\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=8936"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=8936"},{"taxonomy":"post_tag","embeddable":true,"href":"\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=8936"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}