Technology Sharing

FastAPI Learning Road (Forty-one) Customized Return Response

2024-07-12

한어Русский языкEnglishFrançaisIndonesianSanskrit日本語DeutschPortuguêsΕλληνικάespañolItalianoSuomalainenLatina

The interface returns the content in XML format

  1. from fastapi import FastAPI, Response
  2.  
  3. app = FastAPI()
  4.  
  5.  
  6. # ① xml
  7. @app.get("/legacy")
  8. def get_legacy_data():
  9.     data = """<?xml version="1.0"?>
  10.         <shampoo>
  11.         <Header>
  12.             Apply shampoo here.
  13.         </Header>
  14.         <Body>
  15.             You'll have to use soap here.
  16.         </Body>
  17.         </shampoo>
  18.         """
  19.     return Response(content=data, media_type="application/xml")

Let's look at the actual return:

The returned type is in XML format, indicating that the return is successful.

Customizing headers in interface returns

  1. @app.get("/legacy_with_headers")
  2. def get_legacy_with_headers_data():
  3.     headers = {"X-Xtoken": "LC", "Content-Language": "en-US"}
  4.     data = """<?xml version="1.0"?>
  5.         <shampoo>
  6.         <Header>
  7.             Apply shampoo here.
  8.         </Header>
  9.         <Body>
  10.             You'll have to use soap here.
  11.             HERE SOMETHING HEADER YOU DEFINED
  12.         </Body>
  13.         </shampoo>
  14.         """
  15.     return Response(content=data, media_type="application/xml", headers=headers)

Let's look at the actual return

The corresponding interface can return normally, and the corresponding Headers return normally.

Setting cookies

  1. @app.get("/legacy_with_header_cookie")
  2. def legacy_with_header_cookie():
  3.     headers = {"X-Xtoken": "LC-1", "Content-Language": "en-US"}
  4.     data = """<?xml version="1.0"?>
  5.             <shampoo>
  6.             <Header>
  7.                 Apply shampoo here.
  8.             </Header>
  9.             <Body>
  10.                 You'll have to use soap here.
  11.                 HERE SOMETHING HEADER YOU DEFINED AND COOKIE
  12.             </Body>
  13.             </shampoo>
  14.             """
  15.     response = Response(content=data, media_type="application/xml", headers=headers)
  16.     response.set_cookie(key="cookie_key_lc", value="mrli")
  17.     return response

Let's look at the actual return

The interface can return the cookies we set normally, and headers can also be returned normally.

Personal profile

I have devoted myself to the research of technology for more than 30 years. I am proficient in various languages ​​such as Java, Linux, JavaScript, PHP, CSS, etc. I have made many contributions in the field of open source. I have established a developer documentation site to share some problems in technology development for everyone to read.

my contact information

Mail