您的位置：58编程 > fastjson api FastAPI教程自定义响应 - HTML，流，文件和其他

fastjson api FastAPI教程自定义响应 - HTML，流，文件和其他

2023-03-17 18:33 FastAPI教程

fastjson api

Fastjson API 是一个 Java 语言的高性能 JSON 库，它可以将 Java 对象转换成 JSON 格式的字符串，也可以将 JSON 格式的字符串转换成 Java 对象。它是由阿里巴巴公司开发的，并在 Apache 2.0 许可证下发布。

Fastjson API 的特点是性能高、功能强大、使用方便。它支持多种数据格式，包括 XML、JSON、JSONP 等；它还支持多种数据结构，如 List、Map、Set 等；它还有一些特有的功能，如序列化和反序列化时间戳格式的日期对象、序列化和反序列化 JavaBean 到 JSON 的映射关系。

// 使用 Fastjson API 将 JavaBean 转换成 JSON 格式字符串
String jsonString = JSON.toJSONString(user); 
// 使用 Fastjson API 将 JSON 格式字符串转换成 JavaBean 
User user = JSON.parseObject(jsonString, User.class);

FastAPI教程自定义响应 - HTML，流，文件和其他

FastAPI 默认会使用 JSONResponse 返回响应。

你可以通过直接返回 Response 来重载它，参见直接返回响应。

但如果你直接返回 Response，返回数据不会自动转换，也不会自动生成文档（例如，在 HTTP 头 Content-Type 中包含特定的「媒体类型」作为生成的 OpenAPI 的一部分）。

你还可以在路径操作装饰器中声明你想用的 Response。

你从路径操作函数中返回的内容将被放在该 Response 中。

并且如果该 Response 有一个 JSON 媒体类型（application/json），比如使用 JSONResponse 或者 UJSONResponse 的时候，返回的数据将使用你在路径操作装饰器中声明的任何 Pydantic 的 response_model 自动转换（和过滤）。

说明

如果你使用不带有任何媒体类型的响应类，FastAPI 认为你的响应没有任何内容，所以不会在生成的OpenAPI文档中记录响应格式。

使用 ORJSONResponse¶

例如，如果你需要压榨性能，你可以安装并使用 orjson 并将响应设置为 ORJSONResponse。

导入你想要使用的 Response 类（子类）然后在路径操作装饰器中声明它。

from fastapi import FastAPI
from fastapi.responses import ORJSONResponse

app = FastAPI()


@app.get("/items/", response_class=ORJSONResponse)
async def read_items():
    return [{"item_id": "Foo"}]

提示

参数 response_class 也会用来定义响应的「媒体类型」。

在这个例子中，HTTP 头的 Content-Type 会被设置成 application/json。

并且在 OpenAPI 文档中也会这样记录。

小贴士

ORJSONResponse 目前只在 FastAPI 中可用，而在 Starlette 中不可用。

HTML 响应

使用 HTMLResponse 来从 FastAPI 中直接返回一个 HTML 响应。

导入 HTMLResponse。
将 HTMLResponse 作为你的路径操作的 response_class 参数传入。

from fastapi import FastAPI
from fastapi.responses import HTMLResponse

app = FastAPI()


@app.get("/items/", response_class=HTMLResponse)
async def read_items():
    return """
    <html>
        <head>
            <title>Some HTML in here</title>
        </head>
        <body>
            <h1>Look ma! HTML!</h1>
        </body>
    </html>
    """

提示

参数 response_class 也会用来定义响应的「媒体类型」。

在这个例子中，HTTP 头的 Content-Type 会被设置成 text/html。

并且在 OpenAPI 文档中也会这样记录。

返回一个 Response

正如你在直接返回响应中了解到的，你也可以通过直接返回响应在路径操作中直接重载响应。

和上面一样的例子，返回一个 HTMLResponse 看起来可能是这样：

from fastapi import FastAPI
from fastapi.responses import HTMLResponse

app = FastAPI()


@app.get("/items/")
async def read_items():
    html_content = """
    <html>
        <head>
            <title>Some HTML in here</title>
        </head>
        <body>
            <h1>Look ma! HTML!</h1>
        </body>
    </html>
    """
    return HTMLResponse(content=html_content, status_code=200)

警告

路径操作函数直接返回的 Response 不会被 OpenAPI 的文档记录（比如，Content-Type 不会被文档记录），并且在自动化交互文档中也是不可见的。

提示

当然，实际的 Content-Type 头，状态码等等，将来自于你返回的 Response 对象。

OpenAPI 中的文档和重载 Response

如果你想要在函数内重载响应，但是同时在 OpenAPI 中文档化「媒体类型」，你可以使用 response_class 参数并返回一个 Response 对象。

接着 response_class 参数只会被用来文档化 OpenAPI 的路径操作，你的 Response 用来返回响应。

直接返回 HTMLResponse

比如像这样：

from fastapi import FastAPI
from fastapi.responses import HTMLResponse

app = FastAPI()


def generate_html_response():
    html_content = """
    <html>
        <head>
            <title>Some HTML in here</title>
        </head>
        <body>
            <h1>Look ma! HTML!</h1>
        </body>
    </html>
    """
    return HTMLResponse(content=html_content, status_code=200)


@app.get("/items/", response_class=HTMLResponse)
async def read_items():
    return generate_html_response()

在这个例子中，函数 generate_html_response() 已经生成并返回 Response 对象而不是在 str 中返回 HTML。

通过返回函数 generate_html_response() 的调用结果，你已经返回一个重载 FastAPI 默认行为的 Response 对象，

但如果你在 response_class 中也传入了 HTMLResponse，FastAPI 会知道如何在 OpenAPI 和交互式文档中使用 text/html 将其文档化为 HTML。

可用响应

这里有一些可用的响应。

要记得你可以使用 Response 来返回任何其他东西，甚至创建一个自定义的子类。

技术细节

你也可以使用 from starlette.responses import HTMLResponse。

FastAPI 提供了同 fastapi.responses 相同的 starlette.responses 只是为了方便开发者。但大多数可用的响应都直接来自 Starlette。

Response

其他全部的响应都继承自主类 Response。

你可以直接返回它。

Response 类接受如下参数：

content - 一个 str 或者 bytes。
status_code - 一个 int 类型的 HTTP 状态码。
headers - 一个由字符串组成的 dict。
media_type - 一个给出媒体类型的 str，比如 "text/html"。

FastAPI（实际上是 Starlette）将自动包含 Content-Length 的头。它还将包含一个基于 media_type 的 Content-Type 头，并为文本类型附加一个字符集。

from fastapi import FastAPI, Response

app = FastAPI()


@app.get("/legacy/")
def get_legacy_data():
    data = """<?xml version="1.0"?>
    <shampoo>
    <Header>
        Apply shampoo here.
    </Header>
    <Body>
        You"ll have to use soap here.
    </Body>
    </shampoo>
    """
    return Response(content=data, media_type="application/xml")

HTMLResponse

如上文所述，接受文本或字节并返回 HTML 响应。

PlainTextResponse

接受文本或字节并返回纯文本响应。

from fastapi import FastAPI
from fastapi.responses import PlainTextResponse

app = FastAPI()


@app.get("/", response_class=PlainTextResponse)
async def main():
    return "Hello World"

JSONResponse

接受数据并返回一个 application/json 编码的响应。

如上文所述，这是 FastAPI 中使用的默认响应。

ORJSONResponse

如上文所述，ORJSONResponse 是一个使用 orjson 的快速的可选 JSON 响应。

UJSONResponse

UJSONResponse 是一个使用 ujson 的可选 JSON 响应。

警告

在处理某些边缘情况时，ujson 不如 Python 的内置实现那么谨慎。

from fastapi import FastAPI
from fastapi.responses import UJSONResponse

app = FastAPI()


@app.get("/items/", response_class=UJSONResponse)
async def read_items():
    return [{"item_id": "Foo"}]

小贴士

ORJSONResponse 可能是一个更快的选择。

RedirectResponse

返回 HTTP 重定向。默认情况下使用 307 状态代码（临时重定向）。

from fastapi import FastAPI
from fastapi.responses import RedirectResponse

app = FastAPI()


@app.get("/typer")
async def redirect_typer():
    return RedirectResponse("https://typer.tiangolo.com")

StreamingResponse

采用异步生成器或普通生成器/迭代器，然后流式传输响应主体。

from fastapi import FastAPI
from fastapi.responses import StreamingResponse

app = FastAPI()


async def fake_video_streamer():
    for i in range(10):
        yield b"some fake video bytes"


@app.get("/")
async def main():
    return StreamingResponse(fake_video_streamer())

对类似文件的对象使用 StreamingResponse

如果您有类似文件的对象（例如，由 open() 返回的对象），则可以在 StreamingResponse 中将其返回。

包括许多与云存储，视频处理等交互的库。

from fastapi import FastAPI
from fastapi.responses import StreamingResponse

some_file_path = "large-video-file.mp4"
app = FastAPI()


@app.get("/")
def main():
    def iterfile():  # (1)
        with open(some_file_path, mode="rb") as file_like:  # (2)
            yield from file_like  # (3)

    return StreamingResponse(iterfile(), media_type="video/mp4")

小贴士

注意在这里，因为我们使用的是不支持 async 和 await 的标准 open()，我们使用普通的 def 声明了路径操作。

FileResponse

异步传输文件作为响应。

与其他响应类型相比，接受不同的参数集进行实例化：

path - 要流式传输的文件的文件路径。
headers - 任何自定义响应头，传入字典类型。
media_type - 给出媒体类型的字符串。如果未设置，则文件名或路径将用于推断媒体类型。
filename - 如果给出，它将包含在响应的 Content-Disposition 中。

文件响应将包含适当的 Content-Length，Last-Modified 和 ETag 的响应头。

from fastapi import FastAPI
from fastapi.responses import FileResponse

some_file_path = "large-video-file.mp4"
app = FastAPI()


@app.get("/")
async def main():
    return FileResponse(some_file_path)

额外文档

您还可以使用 response 在 OpenAPI 中声明媒体类型和许多其他详细信息：OpenAPI 中的额外文档。

阅读全文

以上是58编程为你收集整理的fastjson api FastAPI教程自定义响应 - HTML，流，文件和其他全部内容。

声明：本站所有文章资源内容，如无特殊说明或标注，均为采集网络资源。如若本站内容侵犯了原著者的合法权益，可联系本站删除。

全部标签 标签详情

flask代码结构 Flask 代码模式

Flask教程

某些东西非常通用，以至于你有很大的机会在绝大部分 Web 应用中，都能找到他们的身影。例如相当多的应用在使用关系数据库而且包...
django中urls路径中用path了 Django4.0 URL调度器-路径转换器

Django4中文教程

...
django删除数据库后重新迁移 Django4.0 迁移-删除模型字段时的注意事项

Django4中文教程

如果在旧迁移中引用了自定义模型字段，则从项目或第三方应用中删除这些字段将导致问题。为了解决这种情况，Django 提供了一些模...
django 模板语言 Django4.0 模板-Django模板语言

Django4中文教程

语法Django 模板是使用 Django 模板语言标记的一个文本文档或Python字符串。模板引擎可以识别和解释一些构造。主要是变量和标签...
django 视 Django4.0 使用会话-在视中使用会话

Django4中文教程

当激活 SessionMiddleware 后，每个 HttpRequest 对象（任何 Django 视图函数的第一个参数）将得到一个 session 属...
django 安装 Django4.0 开始-快速安装指南

Django4中文教程

安装Python作为一个 Python 网络框架，Django 需要 Python。Python 包含了一个名为 SQLite 的轻量级数据库，所以你暂时不必自行...
django 文件 Django4.0 管理文件-文件存储

Django4中文教程

在后台，Django将如何以及在哪里存储文件的决策委托给文件存储系统。这个对象实际上理解文件系统、打开和读取文件等。Django 的...
java文本框组件 Java Swing文本组件

SWING教程

下表列出了JTextComponent类中包含的某些常用的文本组件方法。...我们可以根据两个标准对文本组件进行分类:number of lines in t...
java外观模式例子 Java Swing外观和感觉

SWING教程

Java Swing教程 -Java Swing外观和感觉Swing支持可插拔的外观(L F)。Swing支持可插拔的外观(L F)。...lafClassName参数是提供L F...
MyBatis-Plus CRUD接口-SimpleQuery 工具类

MyBatis-Plus教程

对selectList查询后的结果用Stream流进行了一些封装，使其可以返回一些指定结果，简洁了api的调用需要项目中已注入对应...

fastjson api FastAPI教程 自定义响应 - HTML，流，文件和其他

fastjson api

FastAPI教程 自定义响应 - HTML，流，文件和其他

使用 ORJSONResponse¶

HTML 响应

返回一个 Response

OpenAPI 中的文档和重载 Response

直接返回 HTMLResponse

可用响应

Response

HTMLResponse

PlainTextResponse

JSONResponse

ORJSONResponse

UJSONResponse

RedirectResponse

StreamingResponse

对类似文件的对象使用 StreamingResponse

FileResponse

额外文档

fastjson api FastAPI教程自定义响应 - HTML，流，文件和其他

FastAPI教程自定义响应 - HTML，流，文件和其他