{"id":114,"date":"2026-06-14T09:55:51","date_gmt":"2026-06-14T01:55:51","guid":{"rendered":"https:\/\/www.52runoob.com\/?p=114"},"modified":"2026-06-14T09:55:51","modified_gmt":"2026-06-14T01:55:51","slug":"fastapi-%e4%ba%a4%e4%ba%92%e5%bc%8f-api-%e6%96%87%e6%a1%a3","status":"publish","type":"post","link":"https:\/\/www.52runoob.com\/index.php\/2026\/06\/14\/fastapi-%e4%ba%a4%e4%ba%92%e5%bc%8f-api-%e6%96%87%e6%a1%a3\/","title":{"rendered":"FastAPI \u4ea4\u4e92\u5f0f API \u6587\u6863"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">FastAPI \u6700\u4ee4\u4eba\u60ca\u53f9\u7684\u7279\u6027\u4e4b\u4e00\uff0c\u5c31\u662f\u5b83\u80fd<strong>\u6839\u636e\u4f60\u7684\u4ee3\u7801\u548c\u7c7b\u578b\u63d0\u793a\uff0c100% \u81ea\u52a8\u751f\u6210\u7b26\u5408 OpenAPI \u6807\u51c6\u7684\u4ea4\u4e92\u5f0f API \u6587\u6863<\/strong>\u3002<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\u8fd9\u610f\u5473\u7740\u4f60<strong>\u6c38\u8fdc\u4e0d\u9700\u8981\u624b\u52a8\u7f16\u5199\u6216\u540c\u6b65 API \u6587\u6863<\/strong>\u3002\u4ee3\u7801\u5373\u6587\u6863\uff08Documentation as Code\uff09\uff0c\u4fee\u6539\u4ee3\u7801\u7684\u540c\u65f6\uff0c\u6587\u6863\u81ea\u52a8\u66f4\u65b0\u3002<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\u4e0b\u9762\u6211\u5c06\u5e26\u4f60\u4ece<strong>\u57fa\u7840\u8bbf\u95ee<\/strong>\u5230<strong>\u6df1\u5ea6\u5b9a\u5236<\/strong>\uff0c\u5168\u9762\u638c\u63e1 FastAPI \u7684\u4ea4\u4e92\u5f0f\u6587\u6863\u529f\u80fd\u3002<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h3 class=\"wp-block-heading\">\u4e00\u3001 \u5f00\u7bb1\u5373\u7528\u7684\u4e24\u5927\u6587\u6863\u754c\u9762<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">\u542f\u52a8\u4f60\u7684 FastAPI \u5e94\u7528\u540e\uff0c\u53ef\u4ee5\u76f4\u63a5\u8bbf\u95ee\u4ee5\u4e0b\u4e24\u4e2a\u8def\u5f84\uff1a<\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li><strong>Swagger UI<\/strong> (<code>http:\/\/127.0.0.1:8000\/docs<\/code>)<\/li>\n<\/ol>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>\u7279\u70b9<\/strong>\uff1a\u4ea4\u4e92\u5f0f\u6781\u5f3a\u3002\u4f60\u53ef\u4ee5\u76f4\u63a5\u70b9\u51fb &#8220;Try it out&#8221;\uff0c\u586b\u5165\u53c2\u6570\uff0c\u53d1\u9001\u771f\u5b9e\u7684 HTTP \u8bf7\u6c42\uff0c\u5e76\u67e5\u770b\u54cd\u5e94\u7ed3\u679c\u3001\u72b6\u6001\u7801\u548c cURL \u547d\u4ee4\u3002<\/li>\n\n\n\n<li><strong>\u9002\u7528\u573a\u666f<\/strong>\uff1a\u65e5\u5e38\u5f00\u53d1\u3001\u524d\u540e\u7aef\u8054\u8c03\u3001\u5feb\u901f\u6d4b\u8bd5\u63a5\u53e3\u3002<\/li>\n<\/ul>\n\n\n\n<ol class=\"wp-block-list\">\n<li><strong>ReDoc<\/strong> (<code>http:\/\/127.0.0.1:8000\/redoc<\/code>)<\/li>\n<\/ol>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>\u7279\u70b9<\/strong>\uff1a\u9759\u6001\u3001\u7f8e\u89c2\u3001\u4e09\u680f\u5e03\u5c40\uff08\u5bfc\u822a\u3001\u63cf\u8ff0\u3001\u8bf7\u6c42\/\u54cd\u5e94\u793a\u4f8b\uff09\u3002\u4e0d\u652f\u6301\u76f4\u63a5\u53d1\u9001\u8bf7\u6c42\uff0c\u4f46\u9605\u8bfb\u4f53\u9a8c\u6781\u4f73\u3002<\/li>\n\n\n\n<li><strong>\u9002\u7528\u573a\u666f<\/strong>\uff1a\u4f5c\u4e3a\u5bf9\u5916\u53d1\u5e03\u7684\u5b98\u65b9 API \u53c2\u8003\u624b\u518c\u3002<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h3 class=\"wp-block-heading\">\u4e8c\u3001 \u6df1\u5ea6\u5b9a\u5236\uff1a\u8ba9\u4f60\u7684\u6587\u6863\u4e13\u4e1a\u4e14\u4f18\u96c5<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">\u9ed8\u8ba4\u7684\u6587\u6863\u867d\u7136\u80fd\u7528\uff0c\u4f46\u901a\u8fc7\u7b80\u5355\u7684\u914d\u7f6e\uff0c\u53ef\u4ee5\u4f7f\u5176\u8fbe\u5230\u4f01\u4e1a\u7ea7\u6807\u51c6\u3002<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">1. \u5168\u5c40\u5143\u6570\u636e\u914d\u7f6e (App \u7ea7\u522b)<\/h4>\n\n\n\n<p class=\"wp-block-paragraph\">\u5728\u521b\u5efa <code>FastAPI<\/code> \u5b9e\u4f8b\u65f6\uff0c\u4f20\u5165\u5143\u6570\u636e\uff0c\u8fd9\u4e9b\u4fe1\u606f\u4f1a\u663e\u793a\u5728\u6587\u6863\u7684\u9876\u90e8\u3002<\/p>\n\n\n\n<div class=\"chp-code-block chp-theme-github-dark chp-wrap-on\" data-chp-language=\"plaintext\" data-chp-line-start=\"1\" data-chp-highlight=\"\"><div class=\"chp-toolbar\"><div class=\"chp-toolbar-left\"><span class=\"chp-dots\"><span><\/span><span><\/span><span><\/span><\/span><span class=\"chp-language-label\">\u7eaf\u6587\u672c<\/span><\/div><div class=\"chp-toolbar-right\"><button type=\"button\" class=\"chp-copy-btn\" aria-label=\"\u590d\u5236\u4ee3\u7801\"><svg class=\"chp-icon-copy\" viewBox=\"0 0 24 24\" width=\"14\" height=\"14\" aria-hidden=\"true\"><path fill=\"currentColor\" d=\"M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z\"\/><\/svg><svg class=\"chp-icon-check\" viewBox=\"0 0 24 24\" width=\"14\" height=\"14\" aria-hidden=\"true\" style=\"display:none;\"><path fill=\"currentColor\" d=\"M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z\"\/><\/svg><span class=\"chp-copy-text\">\u590d\u5236<\/span><\/button><\/div><\/div><div class=\"chp-code-wrapper\"><div class=\"chp-line-numbers\" aria-hidden=\"true\"><span>1<\/span><span>2<\/span><span>3<\/span><span>4<\/span><span>5<\/span><span>6<\/span><span>7<\/span><span>8<\/span><span>9<\/span><span>10<\/span><span>11<\/span><span>12<\/span><span>13<\/span><span>14<\/span><span>15<\/span><span>16<\/span><span>17<\/span><span>18<\/span><span>19<\/span><span>20<\/span><span>21<\/span><span>22<\/span><span>23<\/span><span>24<\/span><\/div><pre class=\"chp-pre\" style=\"font-size:14px;\"><code class=\"language-plaintext\">from fastapi import FastAPI\n\napp = FastAPI(\n    title=&quot;\ud83d\ude80 \u6211\u7684\u7535\u5546 API&quot;,\n    description=&quot;\u8fd9\u662f\u4e00\u4e2a\u7528\u4e8e\u7ba1\u7406\u5546\u54c1\u548c\u7528\u6237\u7684\u540e\u7aef\u670d\u52a1\uff0c\u57fa\u4e8e FastAPI \u6784\u5efa\u3002&quot;,\n    version=&quot;1.0.0&quot;,\n    contact={\n        &quot;name&quot;: &quot;\u5f00\u53d1\u56e2\u961f&quot;,\n        &quot;email&quot;: &quot;dev@example.com&quot;,\n        &quot;url&quot;: &quot;https:\/\/example.com&quot;,\n    },\n    license_info={\n        &quot;name&quot;: &quot;Apache 2.0&quot;,\n        &quot;url&quot;: &quot;https:\/\/www.apache.org\/licenses\/LICENSE-2.0.html&quot;,\n    },\n    # \u81ea\u5b9a\u4e49\u6587\u6863\u8def\u5f84 (\u53ef\u9009)\n    docs_url=&quot;\/api-docs&quot;,      # \u5c06 Swagger UI \u6539\u4e3a \/api-docs\n    redoc_url=&quot;\/api-redoc&quot;,    # \u5c06 ReDoc \u6539\u4e3a \/api-redoc\n    openapi_url=&quot;\/openapi.json&quot; # OpenAPI schema \u7684\u8def\u5f84\n)\n\n@app.get(&quot;\/&quot;)\ndef read_root():\n    return {&quot;message&quot;: &quot;\u67e5\u770b\u6587\u6863\u8bf7\u8bbf\u95ee \/api-docs&quot;}<\/code><\/pre><\/div><\/div>\n\n\n\n<h4 class=\"wp-block-heading\">2. \u8def\u7531\u7ea7\u522b\u7684\u63cf\u8ff0 (Summary &amp; Description)<\/h4>\n\n\n\n<p class=\"wp-block-paragraph\">\u4f7f\u7528 <code>summary<\/code>\uff08\u7b80\u77ed\u6458\u8981\uff09\u548c <code>description<\/code>\uff08\u8be6\u7ec6\u8bf4\u660e\uff0c\u652f\u6301 Markdown \u8bed\u6cd5\uff09\u6765\u4e30\u5bcc\u5355\u4e2a\u63a5\u53e3\u7684\u6587\u6863\u3002<\/p>\n\n\n\n<div class=\"chp-code-block chp-theme-github-dark chp-wrap-on\" data-chp-language=\"plaintext\" data-chp-line-start=\"1\" data-chp-highlight=\"\"><div class=\"chp-toolbar\"><div class=\"chp-toolbar-left\"><span class=\"chp-dots\"><span><\/span><span><\/span><span><\/span><\/span><span class=\"chp-language-label\">\u7eaf\u6587\u672c<\/span><\/div><div class=\"chp-toolbar-right\"><button type=\"button\" class=\"chp-copy-btn\" aria-label=\"\u590d\u5236\u4ee3\u7801\"><svg class=\"chp-icon-copy\" viewBox=\"0 0 24 24\" width=\"14\" height=\"14\" aria-hidden=\"true\"><path fill=\"currentColor\" d=\"M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z\"\/><\/svg><svg class=\"chp-icon-check\" viewBox=\"0 0 24 24\" width=\"14\" height=\"14\" aria-hidden=\"true\" style=\"display:none;\"><path fill=\"currentColor\" d=\"M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z\"\/><\/svg><span class=\"chp-copy-text\">\u590d\u5236<\/span><\/button><\/div><\/div><div class=\"chp-code-wrapper\"><div class=\"chp-line-numbers\" aria-hidden=\"true\"><span>1<\/span><span>2<\/span><span>3<\/span><span>4<\/span><span>5<\/span><span>6<\/span><span>7<\/span><span>8<\/span><span>9<\/span><span>10<\/span><span>11<\/span><span>12<\/span><span>13<\/span><span>14<\/span><\/div><pre class=\"chp-pre\" style=\"font-size:14px;\"><code class=\"language-plaintext\">@app.get(\n    &quot;\/items\/{item_id}&quot;,\n    summary=&quot;\u83b7\u53d6\u5546\u54c1\u8be6\u60c5&quot;,\n    description=&quot;&quot;&quot;\n    \u6839\u636e\u5546\u54c1 ID \u83b7\u53d6\u8be6\u7ec6\u4fe1\u606f\u3002\n\n    - **item_id**: \u5fc5\u987b\u662f\u6b63\u6574\u6570\u3002\n    - \u5982\u679c\u5546\u54c1\u4e0d\u5b58\u5728\uff0c\u5c06\u8fd4\u56de 404 \u9519\u8bef\u3002\n    - \u652f\u6301\u901a\u8fc7 `q` \u53c2\u6570\u8fdb\u884c\u6a21\u7cca\u641c\u7d22\u3002\n    &quot;&quot;&quot;,\n    tags=[&quot;\u5546\u54c1\u7ba1\u7406&quot;] # \u7528\u4e8e\u5728\u6587\u6863\u5de6\u4fa7\u5bf9\u63a5\u53e3\u8fdb\u884c\u5206\u7ec4\n)\ndef get_item(item_id: int, q: str | None = None):\n    return {&quot;item_id&quot;: item_id, &quot;query&quot;: q}<\/code><\/pre><\/div><\/div>\n\n\n\n<h4 class=\"wp-block-heading\">3. \u63d0\u4f9b\u8bf7\u6c42\/\u54cd\u5e94\u793a\u4f8b (Examples) \ud83c\udf1f<\/h4>\n\n\n\n<p class=\"wp-block-paragraph\">\u8fd9\u662f\u63d0\u5347\u5f00\u53d1\u8005\u4f53\u9a8c\uff08DX\uff09\u7684<strong>\u6740\u624b\u950f<\/strong>\u3002\u5728 Pydantic \u6a21\u578b\u4e2d\u4f7f\u7528 <code>Field<\/code> \u7684 <code>examples<\/code> \u53c2\u6570\uff0cSwagger UI \u4f1a\u81ea\u52a8\u586b\u5145\u8fd9\u4e9b\u793a\u4f8b\u6570\u636e\uff0c\u524d\u7aef\u5f00\u53d1\u8005\u4e00\u952e\u5373\u53ef\u6d4b\u8bd5\u3002<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><em>(\u6ce8\u610f\uff1a\u4ee5\u4e0b\u4f7f\u7528 Pydantic V2 \u8bed\u6cd5)<\/em><\/p>\n\n\n\n<div class=\"chp-code-block chp-theme-github-dark chp-wrap-on\" data-chp-language=\"plaintext\" data-chp-line-start=\"1\" data-chp-highlight=\"\"><div class=\"chp-toolbar\"><div class=\"chp-toolbar-left\"><span class=\"chp-dots\"><span><\/span><span><\/span><span><\/span><\/span><span class=\"chp-language-label\">\u7eaf\u6587\u672c<\/span><\/div><div class=\"chp-toolbar-right\"><button type=\"button\" class=\"chp-copy-btn\" aria-label=\"\u590d\u5236\u4ee3\u7801\"><svg class=\"chp-icon-copy\" viewBox=\"0 0 24 24\" width=\"14\" height=\"14\" aria-hidden=\"true\"><path fill=\"currentColor\" d=\"M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z\"\/><\/svg><svg class=\"chp-icon-check\" viewBox=\"0 0 24 24\" width=\"14\" height=\"14\" aria-hidden=\"true\" style=\"display:none;\"><path fill=\"currentColor\" d=\"M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z\"\/><\/svg><span class=\"chp-copy-text\">\u590d\u5236<\/span><\/button><\/div><\/div><div class=\"chp-code-wrapper\"><div class=\"chp-line-numbers\" aria-hidden=\"true\"><span>1<\/span><span>2<\/span><span>3<\/span><span>4<\/span><span>5<\/span><span>6<\/span><span>7<\/span><span>8<\/span><span>9<\/span><span>10<\/span><span>11<\/span><span>12<\/span><span>13<\/span><span>14<\/span><span>15<\/span><span>16<\/span><span>17<\/span><span>18<\/span><span>19<\/span><span>20<\/span><span>21<\/span><span>22<\/span><span>23<\/span><span>24<\/span><span>25<\/span><\/div><pre class=\"chp-pre\" style=\"font-size:14px;\"><code class=\"language-plaintext\">from pydantic import BaseModel, Field\n\nclass UserCreate(BaseModel):\n    username: str = Field(\n        ..., \n        min_length=3, \n        max_length=50,\n        description=&quot;\u7528\u6237\u7684\u767b\u5f55\u540d&quot;,\n        examples=[&quot;alice_2024&quot;, &quot;bob_dev&quot;]\n    )\n    email: str = Field(\n        ..., \n        description=&quot;\u7528\u6237\u7684\u7535\u5b50\u90ae\u7bb1&quot;,\n        examples=[&quot;alice@example.com&quot;]\n    )\n    age: int | None = Field(\n        default=None, \n        ge=18, \n        description=&quot;\u7528\u6237\u5e74\u9f84 (\u53ef\u9009)&quot;,\n        examples=[25, 30]\n    )\n\n@app.post(&quot;\/users\/&quot;, response_model=UserCreate, tags=[&quot;\u7528\u6237\u7ba1\u7406&quot;])\ndef create_user(user: UserCreate):\n    return user<\/code><\/pre><\/div><\/div>\n\n\n\n<p class=\"wp-block-paragraph\"><em>\u6548\u679c\uff1a\u5728 <code>\/docs<\/code> \u4e2d\u70b9\u51fb\u8be5\u63a5\u53e3\uff0c\u8bf7\u6c42\u4f53\u8f93\u5165\u6846\u4f1a\u81ea\u52a8\u586b\u5165 <code>{\"username\": \"alice_2024\", \"email\": \"alice@example.com\", \"age\": 25}<\/code>\u3002<\/em><\/p>\n\n\n\n<h4 class=\"wp-block-heading\">4. \u81ea\u5b9a\u4e49\u54cd\u5e94\u72b6\u6001\u7801\u6587\u6863<\/h4>\n\n\n\n<p class=\"wp-block-paragraph\">\u9ed8\u8ba4\u60c5\u51b5\u4e0b\uff0cFastAPI \u4f1a\u8bb0\u5f55 200 \u72b6\u6001\u7801\u3002\u4f60\u53ef\u4ee5\u4f7f\u7528 <code>responses<\/code> \u53c2\u6570\u660e\u786e\u544a\u8bc9\u6587\u6863\u5176\u4ed6\u53ef\u80fd\u7684\u72b6\u6001\u7801\u53ca\u5176\u542b\u4e49\u3002<\/p>\n\n\n\n<div class=\"chp-code-block chp-theme-github-dark chp-wrap-on\" data-chp-language=\"plaintext\" data-chp-line-start=\"1\" data-chp-highlight=\"\"><div class=\"chp-toolbar\"><div class=\"chp-toolbar-left\"><span class=\"chp-dots\"><span><\/span><span><\/span><span><\/span><\/span><span class=\"chp-language-label\">\u7eaf\u6587\u672c<\/span><\/div><div class=\"chp-toolbar-right\"><button type=\"button\" class=\"chp-copy-btn\" aria-label=\"\u590d\u5236\u4ee3\u7801\"><svg class=\"chp-icon-copy\" viewBox=\"0 0 24 24\" width=\"14\" height=\"14\" aria-hidden=\"true\"><path fill=\"currentColor\" d=\"M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z\"\/><\/svg><svg class=\"chp-icon-check\" viewBox=\"0 0 24 24\" width=\"14\" height=\"14\" aria-hidden=\"true\" style=\"display:none;\"><path fill=\"currentColor\" d=\"M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z\"\/><\/svg><span class=\"chp-copy-text\">\u590d\u5236<\/span><\/button><\/div><\/div><div class=\"chp-code-wrapper\"><div class=\"chp-line-numbers\" aria-hidden=\"true\"><span>1<\/span><span>2<\/span><span>3<\/span><span>4<\/span><span>5<\/span><span>6<\/span><span>7<\/span><span>8<\/span><span>9<\/span><span>10<\/span><span>11<\/span><span>12<\/span><span>13<\/span><span>14<\/span><span>15<\/span><\/div><pre class=\"chp-pre\" style=\"font-size:14px;\"><code class=\"language-plaintext\">from fastapi import HTTPException, status\n\n@app.get(\n    &quot;\/items\/{item_id}&quot;,\n    responses={\n        404: {&quot;description&quot;: &quot;\u5546\u54c1\u672a\u627e\u5230&quot;},\n        400: {&quot;description&quot;: &quot;\u65e0\u6548\u7684 Item ID&quot;}\n    }\n)\ndef get_item_detail(item_id: int):\n    if item_id &lt; 0:\n        raise HTTPException(status_code=400, detail=&quot;\u65e0\u6548\u7684 Item ID&quot;)\n    if item_id != 1:\n        raise HTTPException(status_code=404, detail=&quot;\u5546\u54c1\u672a\u627e\u5230&quot;)\n    return {&quot;item_id&quot;: item_id, &quot;name&quot;: &quot;Laptop&quot;}<\/code><\/pre><\/div><\/div>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h3 class=\"wp-block-heading\">\u4e09\u3001 \u9ad8\u7ea7\u6280\u5de7\uff1a\u5728\u6587\u6863\u4e2d\u96c6\u6210\u5b89\u5168\u8ba4\u8bc1<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">\u5982\u679c\u4f60\u7684 API \u9700\u8981\u9274\u6743\uff0cFastAPI \u4f1a\u81ea\u52a8\u5728\u6587\u6863\u53f3\u4e0a\u89d2\u751f\u6210\u4e00\u4e2a <strong>&#8220;Authorize&#8221; (\u6388\u6743)<\/strong> \u6309\u94ae\u3002<\/p>\n\n\n\n<div class=\"chp-code-block chp-theme-github-dark chp-wrap-on\" data-chp-language=\"plaintext\" data-chp-line-start=\"1\" data-chp-highlight=\"\"><div class=\"chp-toolbar\"><div class=\"chp-toolbar-left\"><span class=\"chp-dots\"><span><\/span><span><\/span><span><\/span><\/span><span class=\"chp-language-label\">\u7eaf\u6587\u672c<\/span><\/div><div class=\"chp-toolbar-right\"><button type=\"button\" class=\"chp-copy-btn\" aria-label=\"\u590d\u5236\u4ee3\u7801\"><svg class=\"chp-icon-copy\" viewBox=\"0 0 24 24\" width=\"14\" height=\"14\" aria-hidden=\"true\"><path fill=\"currentColor\" d=\"M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z\"\/><\/svg><svg class=\"chp-icon-check\" viewBox=\"0 0 24 24\" width=\"14\" height=\"14\" aria-hidden=\"true\" style=\"display:none;\"><path fill=\"currentColor\" d=\"M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z\"\/><\/svg><span class=\"chp-copy-text\">\u590d\u5236<\/span><\/button><\/div><\/div><div class=\"chp-code-wrapper\"><div class=\"chp-line-numbers\" aria-hidden=\"true\"><span>1<\/span><span>2<\/span><span>3<\/span><span>4<\/span><span>5<\/span><span>6<\/span><span>7<\/span><span>8<\/span><span>9<\/span><span>10<\/span><span>11<\/span><span>12<\/span><span>13<\/span><span>14<\/span><span>15<\/span><span>16<\/span><span>17<\/span><span>18<\/span><\/div><pre class=\"chp-pre\" style=\"font-size:14px;\"><code class=\"language-plaintext\">from fastapi import FastAPI, Depends, HTTPException, status\nfrom fastapi.security import HTTPBearer, HTTPAuthorizationCredentials\n\napp = FastAPI()\nsecurity = HTTPBearer()\n\ndef get_current_user(credentials: HTTPAuthorizationCredentials = Depends(security)):\n    if credentials.credentials != &quot;super-secret-token&quot;:\n        raise HTTPException(\n            status_code=status.HTTP_401_UNAUTHORIZED,\n            detail=&quot;\u65e0\u6548\u7684 Token&quot;,\n            headers={&quot;WWW-Authenticate&quot;: &quot;Bearer&quot;},\n        )\n    return {&quot;username&quot;: &quot;admin&quot;}\n\n@app.get(&quot;\/protected-data&quot;)\ndef protected_route(user: dict = Depends(get_current_user)):\n    return {&quot;message&quot;: f&quot;\u6b22\u8fce, {user[&#039;username&#039;]}! \u8fd9\u662f\u673a\u5bc6\u6570\u636e\u3002&quot;}<\/code><\/pre><\/div><\/div>\n\n\n\n<p class=\"wp-block-paragraph\"><em>\u6548\u679c\uff1a\u5728 <code>\/docs<\/code> \u4e2d\uff0c\u4f60\u53ef\u4ee5\u70b9\u51fb &#8220;Authorize&#8221;\uff0c\u8f93\u5165 <code>super-secret-token<\/code>\uff0c\u4e4b\u540e\u8be5\u63a5\u53e3\u53d1\u51fa\u7684\u6240\u6709\u8bf7\u6c42\u90fd\u4f1a\u81ea\u52a8\u5728 Header \u4e2d\u5e26\u4e0a <code>Authorization: Bearer super-secret-token<\/code>\u3002<\/em><\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h3 class=\"wp-block-heading\">\u56db\u3001 \u751f\u4ea7\u73af\u5883\uff1a\u5982\u4f55\u9690\u85cf\u6587\u6863\uff1f<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">\u5728\u6b63\u5f0f\u7684\u751f\u4ea7\u73af\u5883\u4e2d\uff0c\u51fa\u4e8e\u5b89\u5168\u8003\u8651\uff0c\u4f60\u53ef\u80fd\u4e0d\u5e0c\u671b\u66b4\u9732 API \u6587\u6863\u3002\u53ea\u9700\u5728\u521b\u5efa <code>FastAPI<\/code> \u5b9e\u4f8b\u65f6\u5c06 URL \u8bbe\u7f6e\u4e3a <code>None<\/code> \u5373\u53ef\uff1a<\/p>\n\n\n\n<div class=\"chp-code-block chp-theme-github-dark chp-wrap-on\" data-chp-language=\"plaintext\" data-chp-line-start=\"1\" data-chp-highlight=\"\"><div class=\"chp-toolbar\"><div class=\"chp-toolbar-left\"><span class=\"chp-dots\"><span><\/span><span><\/span><span><\/span><\/span><span class=\"chp-language-label\">\u7eaf\u6587\u672c<\/span><\/div><div class=\"chp-toolbar-right\"><button type=\"button\" class=\"chp-copy-btn\" aria-label=\"\u590d\u5236\u4ee3\u7801\"><svg class=\"chp-icon-copy\" viewBox=\"0 0 24 24\" width=\"14\" height=\"14\" aria-hidden=\"true\"><path fill=\"currentColor\" d=\"M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z\"\/><\/svg><svg class=\"chp-icon-check\" viewBox=\"0 0 24 24\" width=\"14\" height=\"14\" aria-hidden=\"true\" style=\"display:none;\"><path fill=\"currentColor\" d=\"M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z\"\/><\/svg><span class=\"chp-copy-text\">\u590d\u5236<\/span><\/button><\/div><\/div><div class=\"chp-code-wrapper\"><div class=\"chp-line-numbers\" aria-hidden=\"true\"><span>1<\/span><span>2<\/span><span>3<\/span><span>4<\/span><span>5<\/span><span>6<\/span><\/div><pre class=\"chp-pre\" style=\"font-size:14px;\"><code class=\"language-plaintext\"># \u751f\u4ea7\u73af\u5883\u914d\u7f6e\napp = FastAPI(\n    docs_url=None,      # \u7981\u7528 Swagger UI\n    redoc_url=None,     # \u7981\u7528 ReDoc\n    openapi_url=None    # \u7981\u7528 OpenAPI schema \u4e0b\u8f7d (\u53ef\u9009\uff0c\u4f46\u67d0\u4e9b\u5ba2\u6237\u7aef\u53ef\u80fd\u4f9d\u8d56\u5b83)\n)<\/code><\/pre><\/div><\/div>\n\n\n\n<p class=\"wp-block-paragraph\"><em>(\u6700\u4f73\u5b9e\u8df5\uff1a\u901a\u8fc7\u73af\u5883\u53d8\u91cf\u63a7\u5236\uff0c\u5982 <code>docs_url=\"\/docs\" if settings.ENV == \"dev\" else None<\/code>)<\/em><\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h3 class=\"wp-block-heading\">\u4e94\u3001 \u603b\u7ed3\uff1aFastAPI \u6587\u6863\u7684\u6700\u4f73\u5b9e\u8df5\u6e05\u5355<\/h3>\n\n\n\n<ol class=\"wp-block-list\">\n<li><strong>\u59cb\u7ec8\u4f7f\u7528\u7c7b\u578b\u63d0\u793a (Type Hints)<\/strong>\uff1a\u8fd9\u662f\u81ea\u52a8\u751f\u6210\u6587\u6863\u7684\u57fa\u77f3\u3002<\/li>\n\n\n\n<li><strong>\u5584\u7528 <code>description<\/code> \u548c <code>examples<\/code><\/strong>\uff1a\u628a\u6587\u6863\u5f53\u6210\u7ed9\u524d\u7aef\/\u7b2c\u4e09\u65b9\u5f00\u53d1\u8005\u7684\u201c\u4ea7\u54c1\u8bf4\u660e\u4e66\u201d\u6765\u5199\u3002<\/li>\n\n\n\n<li><strong>\u4f7f\u7528 <code>tags<\/code> \u5bf9\u63a5\u53e3\u8fdb\u884c\u903b\u8f91\u5206\u7ec4<\/strong>\uff1a\u5f53\u63a5\u53e3\u8d85\u8fc7 10 \u4e2a\u65f6\uff0c\u5206\u7ec4\u80fd\u6781\u5927\u63d0\u5347\u6587\u6863\u7684\u53ef\u8bfb\u6027\u3002<\/li>\n\n\n\n<li><strong>\u5229\u7528 <code>responses<\/code> \u660e\u786e\u9519\u8bef\u7801<\/strong>\uff1a\u8ba9\u8c03\u7528\u8005\u6e05\u695a\u77e5\u9053\u5728\u4ec0\u4e48\u60c5\u51b5\u4e0b\u4f1a\u6536\u5230 4xx \u6216 5xx \u9519\u8bef\u3002<\/li>\n<\/ol>\n\n\n\n<p class=\"wp-block-paragraph\">\u4f60\u53ef\u4ee5\u5c1d\u8bd5\u5728\u4f60\u73b0\u6709\u7684 FastAPI \u9879\u76ee\u4e2d\uff0c\u4e3a\u4e00\u4e2a\u63a5\u53e3\u6dfb\u52a0 <code>summary<\/code>\u3001<code>description<\/code> \u548c <code>examples<\/code>\uff0c\u7136\u540e\u5237\u65b0 <code>\/docs<\/code> \u9875\u9762\uff0c\u7acb\u523b\u5c31\u80fd\u770b\u5230\u4e13\u4e1a\u7ea7\u7684\u6587\u6863\u6548\u679c\uff01<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\u5982\u679c\u4f60\u5728\u5b9a\u5236\u6587\u6863\u65f6\u9047\u5230\u4efb\u4f55\u95ee\u9898\uff08\u4f8b\u5982\uff1a\u5982\u4f55\u4e3a\u590d\u6742\u7684\u5d4c\u5957\u6a21\u578b\u6dfb\u52a0\u793a\u4f8b\uff09\uff0c\u968f\u65f6\u544a\u8bc9\u6211\uff01<\/p>\n","protected":false},"excerpt":{"rendered":"<p>FastAPI \u6700\u4ee4\u4eba\u60ca\u53f9\u7684\u7279\u6027\u4e4b\u4e00\uff0c\u5c31\u662f\u5b83\u80fd\u6839\u636e\u4f60\u7684\u4ee3\u7801\u548c&hellip;<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[14],"tags":[],"class_list":["post-114","post","type-post","status-publish","format-standard","hentry","category-fastapi-"],"_links":{"self":[{"href":"https:\/\/www.52runoob.com\/index.php\/wp-json\/wp\/v2\/posts\/114","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.52runoob.com\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.52runoob.com\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.52runoob.com\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.52runoob.com\/index.php\/wp-json\/wp\/v2\/comments?post=114"}],"version-history":[{"count":1,"href":"https:\/\/www.52runoob.com\/index.php\/wp-json\/wp\/v2\/posts\/114\/revisions"}],"predecessor-version":[{"id":115,"href":"https:\/\/www.52runoob.com\/index.php\/wp-json\/wp\/v2\/posts\/114\/revisions\/115"}],"wp:attachment":[{"href":"https:\/\/www.52runoob.com\/index.php\/wp-json\/wp\/v2\/media?parent=114"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.52runoob.com\/index.php\/wp-json\/wp\/v2\/categories?post=114"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.52runoob.com\/index.php\/wp-json\/wp\/v2\/tags?post=114"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}