小编Chr*_*ris的帖子

注意：这个问题与这里的问题不同，因为我需要它与 Swagger 一起工作。

给定一个 FastAPIGET端点，我希望允许任意一组 URL 参数，同时保持 Swagger 支持。

我的用例是我想要支持一组类似于 JSON API 的查询参数，如下所示：

/api/books/?include=author&sort=name,zip&sort[author]=-lname&fields=name,phone,street

使用方括号使我无法使用传统的类来对查询参数进行建模，因此我直接使用该Request对象。但是，我想使用 Swagger 来测试端点。我找不到提供任意 URL 参数的方法。我很高兴将它们作为单个字符串输入。

人们可能会这样想：

def books(**params): 
    ....

这给出了一个curl语句：

api/books?params=sort%5Bone%5D%3Dtwo'

我真正想要的是：

api/books?sort&one%5D%3Dtwo'

我第一次使用 FastAPI 开发一个小型 API。我用来uvicorn运行该应用程序。

当我使用时：

$ uvicorn main:app --host 0.0.0.0

我可以从网络内部（使用我的公共 IP）访问该应用程序，但不能从外部访问该应用程序。我已经检查了防火墙，甚至尝试完全禁用它，但是没有任何效果。我只是希望能够向外界展示该应用程序。我怎样才能做到这一点？

当有人点击 API 时是否可以获取 cookie？我需要读取每个请求的cookie。

@app.get("/")
async def root(text: str, sessionKey: str = Header(None)):
    print(sessionKey)
    return {"message": text+" returned"}

if __name__ == "__main__":
    uvicorn.run("main:app", host="0.0.0.0", port=5001 ,reload=True)

我有一个 FastAPI 应用程序，我希望将默认日志写入 STDOUT，并使用 JSON 格式的以下数据：

应用程序日志应如下所示：

{
 "XYZ": {
   "log": {
     "level": "info",
     "type": "app",
     "timestamp": "2022-01-16T08:30:08.181Z",
     "file": "api/predictor/predict.py",
     "line": 34,
     "threadId": 435454,
     "message": "API Server started on port 8080 (development)"
    }
  }
}

访问日志应如下所示：

{
 "XYZ": {
   "log": {
     "level": "info",
     "type": "access",
     "timestamp": "2022-01-16T08:30:08.181Z",
     "message": "GET /app/health 200 6ms"
   },
   "req": {
     "url": "/app/health",
     "headers": {
       "host": "localhost:8080",
       "user-agent": "curl/7.68.0",
       "accept": "*/*"
     },
     "method": "GET",
     "httpVersion": "1.1",
     "originalUrl": "/app/health",
     "query": {}
   },
   "res": {
     "statusCode": 200,
     "body": …

我正在构建一个 FastAPI 应用程序，其中有很多 Pydantic 模型。尽管应用程序运行良好，但正如预期的那样，OpenAPI (Swagger UI) 文档并未在该Schemas部分下显示所有这些模型的架构。

这是pydantic的内容schemas.py

import socket
from datetime import datetime
from enum import Enum
from typing import Any, Dict, List, Optional, Set, Union

from pydantic import BaseModel, Field, validator
from typing_extensions import Literal

ResponseData = Union[List[Any], Dict[str, Any], BaseModel]


# Not visible in Swagger UI
class PageIn(BaseModel):
    page_size: int = Field(default=100, gt=0)
    num_pages: int = Field(default=1, gt=0, exclude=True)
    start_page: int = Field(default=1, gt=0, exclude=True)

# visible under schemas on Swagger UI
class …

如何在FastAPI Swagger autodocs中为 API 方法设置自定义排序顺序？

这个问题展示了如何在 Java 中做到这一点。我之前的问题询问如何按“方法”排序，这是受支持的排序方法。我真的很想更进一步，以便我可以确定方法出现的顺序。现在DELETE显示在顶部，但我希望 API 方法的顺序为：GET, POST, PUT, DELETE。

我知道可以在 JavaScript 中实现自定义排序并将该函数提供给operationsSorter，但您不能从swagger_ui_parametersPython 绑定中可用的属性中包含它。有什么方法可以在Python中完成这个任务吗？

from fastapi import FastAPI

app = FastAPI(swagger_ui_parameters={"operationsSorter": "method"})

@app.get("/")
def list_all_components():
    pass

@app.get("/{component_id}")
def get_component(component_id: int):
    pass

@app.post("/")
def create_component():
    pass

@app.put("/{component_id}")
def update_component(component_id: int):
    pass

@app.delete("/{component_id}")
def delete_component(component_id: int):
    pass