无API文档情况下,如何确定HTTP请求所需的请求头?
如何确定无文档API所需的HTTP请求头
面对没有官方文档的API,确定请求头确实有点棘手,但有几个靠谱的方法可以帮你解决这个问题,结合你给出的爱尔兰铁路API例子,我来逐一说明:
1. 抓包分析真实场景的请求
这是最直接有效的方法:
- 用浏览器的开发者工具(F12打开「网络」面板),或者第三方工具如Charles、Fiddler,模拟用户在对应网站上的操作(比如去爱尔兰铁路官网查询Bray站的实时数据),观察触发的API请求。
- 查看请求头里的所有字段,比如
Accept、User-Agent、Referer等,这些都是网站自身调用API时用的合法头,照搬过来基本不会出错。 - 你给出的curl命令里的
Accept: application/xml和Content-Type: application/xml,大概率就是从抓包中获取的——因为你需要XML格式的响应,所以必须告诉服务器你的需求。
2. 试错法结合响应反馈
如果抓包不方便,可以从最简请求开始测试,根据服务器的错误提示调整:
- 先发送不带额外头的基础请求:
curl http://api.irishrail.ie/realtime/realtime.asmx/getStationDataByNameXML?StationDesc=Bray - 如果返回
406 Not Acceptable,说明服务器无法返回你默认请求的格式,这时候就需要添加Accept头指定XML;如果返回415 Unsupported Media Type,则可能需要补充Content-Type头(虽然GET请求通常不需要请求体,但部分严格的API会要求这个头来确认格式)。
3. 参考同类API的通用规范
即使当前API没文档,同类型的API(比如公共交通类)通常会遵循通用的HTTP规范:
- 如需指定响应格式,用
Accept头,比如XML对应application/xml,JSON对应application/json; - 如需身份认证,可能需要
Authorization头(Bearer Token或Basic Auth); - 很多API会校验
User-Agent,模拟浏览器的UA值可以避免被拦截。
4. 挖掘API的隐藏描述信息
有些看似无文档的API其实藏着线索:
- 你例子中的是ASMX(ASP.NET Web Service),直接访问
http://api.irishrail.ie/realtime/realtime.asmx,可能会看到自动生成的WSDL服务描述,里面会明确请求/响应的格式要求; - 查看服务器返回的响应头,比如
Allow头会告诉你允许的HTTP方法,错误响应的消息体也经常会提示缺少哪个必要的请求头。
你的示例curl命令解析
最后再拆解一下你给出的命令,明确每个请求头的作用:
curl -H "Accept: application/xml" -H "Content-Type: application/xml" -X GET http://api.irishrail.ie/realtime/realtime.asmx/getStationDataByNameXML\?StationDesc\=Bray
Accept: application/xml:告诉服务器「我希望你返回XML格式的响应」Content-Type: application/xml:虽然GET请求没有请求体,但这个头是告诉服务器「我的请求内容格式是XML」,部分严格的Web Service会要求这个字段来匹配处理逻辑
内容的提问来源于stack exchange,提问作者Paul Brittain
相关产品推荐
相关产品推荐

