跳到主要内容

HTTP请求参数类型及其在Swagger文档和实际请求中的表示方式

· 阅读需 1 分钟
素明诚
Full stack development
参数类型Swagger 描述说明示例(传参形式)
Query Parameters参数在 URL 的查询部分使用 ? 开始,并使用 & 分隔多个参数http://sumingcheng.cn/api?param=value
Path Parameters参数是 URL 路径的一部分路径参数通常用花括号 表示,并在实际请求中替换为实际值http://sumingcheng.cn/api/users/{userId}
Request Body参数在 HTTP 请求体中通常用于 POST、PUT 或 PATCH 请求,可以是 JSON、XML 等格式{ "username": "John", "email": "john@sumingcheng.cn" }
Header Parameters参数在 HTTP 请求头中用于传递额外的元数据,如身份验证令牌、客户端可接受的内容类型等Authorization: Bearer token_value
Cookie Parameters参数在 HTTP cookies 中用于会话管理、用户跟踪等sessionId=12345
Form Data Parameters参数在表单数据中通常用于提交 HTML 表单,使用 application/x-www-form-urlencoded 或 multipart/form-data 格式username=John&email=john@sumingcheng.cn