【python】fastapi response返回文本、音视频多媒体资源实现

落日映苍穹つ 2024-03-24 15:34 87阅读 0赞

### 返回HTML ###

`HTMLResponse`是FastAPI中自带的一个响应类，用于返回HTML格式的响应。使用方法如下：

from fastapi import FastAPI, HTMLResponse
    
    app = FastAPI()
    
    @app.get("/", response_class=HTMLResponse)
    async def read_root():
        html_content = """
         <!DOCTYPE html>
        <html>
            <head>
                <title>FastAPI HTMLResponse Example</title>
            </head>
            <body>
                <h1>Hello, World!</h1>
            </body>
        </html>
        """
        return html_content

在上面的例子中，我们在装饰器中指定了`response_class=HTMLResponse`，表示我们需要返回一个HTML响应。然后在函数中，我们返回了一个HTML格式的字符串。FastAPI会自动将这个字符串封装成一个`HTMLResponse`对象，并设置 `Content-Type` 为 `text/html`，将其返回给客户端。

### 返回图片 ###

返回图片，可以使用`FileResponse`类。`FileResponse`类是FastAPI提供的专门用于返回文件的Response类。可以使用`FileResponse`类将图片文件作为响应返回给客户端。

示例代码：

from fastapi import FastAPI
    from fastapi.responses import FileResponse
    
    app = FastAPI()
    
    
    @app.get("/image")
    async def get_image():
        filename = "path/to/image.jpg"
        return FileResponse(filename, media_type="image/jpeg")

在这个例子中，我们使用`FileResponse`类返回了一张图片。`FileResponse`类的第一个参数是文件的路径，第二个参数（`media_type`）是文件的MIME类型。在这个例子中，我们指定了图片的MIME类型为`image/jpeg`。

### 返回音频 ###

返回音频时，需要设置正确的`media_type`，通常为`audio/mpeg`或`audio/wav`，具体取决于音频文件的格式。可以通过`FileResponse`的`media_type`参数来设置，例如：

from fastapi import FastAPI
    from fastapi.responses import FileResponse
    
    app = FastAPI()
    
    @app.get("/audio")
    async def get_audio():
        return FileResponse("audio.mp3", media_type="audio/mpeg")

在上述代码中，我们返回了名为`audio.mp3`的音频文件，并且将`media_type`设置为`audio/mpeg`。

### 返回视频 ###

视频通常返回的是视频文件的二进制数据，需要设置`media_type`为视频格式的MIME类型。以下是返回视频文件的示例代码：

from fastapi import FastAPI, Response
    from fastapi.responses import FileResponse
    
    app = FastAPI()
    
    @app.get("/video")
    def read_video():
        video_path = "path/to/video.mp4"
        return FileResponse(video_path, media_type="video/mp4")

其中，`FileResponse`会使用`media_type`参数来设置响应的MIME类型。在这个例子中，我们将`media_type`设置为`video/mp4`，表示返回的是一个MP4格式的视频文件。

### 返回PDF ###

使用 `media_type='application/pdf'` 来返回 PDF 文件。下面是一个示例代码：

from fastapi import FastAPI
    from fastapi.responses import FileResponse
    
    app = FastAPI()
    
    @app.get("/download-pdf")
    async def download_pdf():
        file_path = "/path/to/pdf/file.pdf"
        return FileResponse(file_path, media_type='application/pdf', filename="file.pdf")

其中，`/path/to/pdf/file.pdf` 是 PDF 文件在本地的路径，`filename="file.pdf"` 是下载下来的文件的名称。

### 总结 ###

<table> 
 <thead> 
  <tr> 
   <th>media</th> 
   <th>解释</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>HTMLResponse</td> 
   <td>返回HTML</td> 
  </tr> 
  <tr> 
   <td>image/jpeg</td> 
   <td>返回图片</td> 
  </tr> 
  <tr> 
   <td>audio/mpeg</td> 
   <td>返回音频</td> 
  </tr> 
  <tr> 
   <td>video/mp4</td> 
   <td>返回视频</td> 
  </tr> 
  <tr> 
   <td>application/pdf</td> 
   <td>返回PDF</td> 
  </tr> 
 </tbody> 
</table>