Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Django-Oasis
0.1.dev20241127055010
Logo
Django-Oasis
0.1.dev20241127055010
  • 快速入门
  • 请求操作
  • 查询参数 (Query)
  • 请求头参数 (Header)
  • 请求 cookie 参数 (Cookie)
  • 路径参数 (Path)
  • 请求体 (Body)
  • 请求响应
  • 请求与响应指南
    • 属性名与别名
    • 参数默认值
    • 擦除参数
    • 可为 null 的参数
    • 只读与只写
    • 必需参数
  • 上传文件
  • 分页
  • 用户认证
  • 项目布局
    • 多实例布局
    • 分配不同的路由前缀(单实例)
  • Schema
    • Model Schema
    • 验证数据
    • Hooks
  • API 参考

示例

  • RESTful
Back to top
View this page

请求头参数 (Header)¶

声明和获取请求头参数可直接参考 查询参数 (Query) 章节。他们的实现方式是一样的(参数样式有差异),仅仅是获取参数的位置不同,所以使用以下类同理替换即可。

  • django_oasis.parameter.Header

  • django_oasis.parameter.HeaderItem

参数样式查询表¶

数组样式¶

以下示例的参数结果示例 color = ["blue", "black", "brown"]

color: blue,black,brown (default)¶

views.py [示例1]¶
@Resource("/array/simple/false")
class ArraySimpleFalseAPI:
    def get(
        self,
        color=HeaderItem(
            schema.List(schema.String()),
            Style("simple", False),
        ),
    ):
        ...
SwaggerUI [示例1]
Next
请求 cookie 参数 (Cookie)
Previous
查询参数 (Query)
Copyright ©
Made with Sphinx and @pradyunsg's Furo
On this page
  • 请求头参数 (Header)
    • 参数样式查询表
      • 数组样式
        • color: blue,black,brown (default)