TRESTRequest：是否可以在 POST 请求中使用自定义媒体类型？

例如，我们有一个 API，需要我们自己的供应商特定内容类型application/vnd.xxxx.custom.custom-data+json但查看 REST.Client 的源代码，它似乎总是默认为 REST.Types 中的 ContentType 之一，例如在分配时ctNone在我的正文请求中，它将默认为ctAPPLICATION_X_WWW_FORM_URLENCODED.

我尝试将内容类型直接分配给 TRESTClient.ContentType 属性，但它会被 TRESTRequest.ContentType 值覆盖。我还在 TRESTRequest 上添加了自定义内容类型作为参数，该参数确实被识别但仍然附加ctAPPLICATION_X_WWW_FORM_URLENCODED最后导致无效的 mime 类型异常。

begin
  APIClient := TRESTClient.Create(API_URL);
  APIRequest := TRESTRequest.Create(nil);

  try
    JsonToSend := TStringStream.Create(strJson, TEncoding.UTF8);
    APIClient.Accept := 'application/vnd.xxxx.custom.custom-data+json';
    // Below line gets overwritten
    APIClient.ContentType := 'application/vnd.xxxx.custom.custom-data+json';
    APIRequest.Client := APIClient;
    APIRequest.Resource := 'ENDPOINT_URL';
    APIRequest.Accept := 'application/vnd.xxxx.custom.custom-data+json';

    APIRequest.AddParameter(
      'Content-Type',
      'application/vnd.xxxx.custom.custom-data+json',
      pkHTTPHEADER,
      [poDoNotEncode]
      );  // This includes the custom CT in the request but appends the preset one as well so in this case ctAPPLICATION_X_WWW_FORM_URLENCODED when ctNone is set

    APIRequest.AddBody(JsonToSend, ctNone);
    APIRequest.Method := rmPost;
    try
      APIRequest.Execute;
    except
      on E: Exception do
        ShowMessage('Error on request: '#13#10 + e.Message);
    end;
  finally
    JsonToSend.Free;
  end;
end;

对我来说，我希望存在一种情况，如果在标头参数中提供了内容类型，它将使用指定的内容类型而不是任何预设的内容类型。但是，由于提供了未知的媒体类型，因此会引发 API 异常。 API异常如下：

Invalid mime type "application/vnd.xxxx.custom.custom-data+json, application/x-www-form-urlencoded": Invalid token character ',' in token "vnd.xxxx.custom.custom-data+json, application/x-www-form-urlencoded"

我的理解是，它识别了参数中提供的自定义内容类型，但仍然在该请求标头中附加 REST.Types 中的预设内容类型之一，导致其失败。我希望它发送带有请求标头的正文application/vnd.xxxx.custom.custom-data+json排除application/x-www-form-urlencoded.

显然TRestCLient试图在你的场景中表现得太聪明。然而，有一个常规的方法可以解决这个问题。关键是：

1. 将单个内容添加到请求正文，该内容不能是以下任何内容ctNone, ctMULTIPART_FORM_DATA or ctAPPLICATION_X_WWW_FORM_URLENCODED.
2. 覆盖Content-Type使用自定义标头值。

示例代码：

uses
  System.NetConsts;

RESTClient1.BaseURL := 'https://postman-echo.com/post';
RESTRequest1.Method := rmPOST;
RESTRequest1.Body.Add('{ "some": "data" }', ctAPPLICATION_JSON);
RESTRequest1.AddParameter(sContentType, 'application/vnd.hmlr.corres.corres-data+json',
  pkHTTPHEADER, [poDoNotEncode]);
RESTRequest1.Execute;

echo 服务的响应是：

{
  "args":{
  },
  "data":{
    "some":"data"
  },
  "files":{
  },
  "form":{
  },
  "headers":{
    "x-forwarded-proto":"https",
    "host":"postman-echo.com",
    "content-length":"18",
    "accept":"application/json, text/plain; q=0.9, text/html;q=0.8,",
    "accept-charset":"UTF-8, *;q=0.8",
    "content-type":"application/vnd.hmlr.corres.corres-data+json",
    "user-agent":"Embarcadero RESTClient/1.0",
    "x-forwarded-port":"443"
  },
  "json":{
    "some":"data"
  },
  "url":"https://postman-echo.com/post"
}

注意回显的标题，尤其是Content-Type当然。我在 Delphi 10.2 Tokyo 中测试了该示例，因此希望它也能在 XE8 中运行。

Edit

您观察到的行为是错误（RSP-14001） https://quality.embarcadero.com/browse/RSP-14001那是已在 RAD Studio 10.2 东京修复 https://edn.embarcadero.com/article/44747.

有多种方法可以解决这个问题。仅举几例：

1. 调整您的 API丢弃辅助 mime 类型。
2. 更改您的客户端实施 to TNetHttpClient相反，如果您可以放弃所有额外的福利TRestClient提供。
3. Upgrade到 RAD Studio 10.2+。
4. Hack it!然而这个选项强烈劝阻，但它可以帮助你更好地理解TRestClient实施细节。

最简单的破解方法是修补方法TCustomRESTRequest.ContentType（注意我们谈论的是单个参数的不变性）返回ContentType一个参数，如果它的AParamsArray参数包含单一参数类型pkREQUESTBODY。这将允许我们将正文添加到类型的请求中ctNone这样修补后的方法就会返回ctNone以及，这将有效地防止附加另一个值Content-Type header.

另一种选择是 patch 方法TRESTHTTP.PrepareRequest更喜欢定制Content-Type推断请求的内容类型之前的标头。顺便说一句，这就是当前实现在 RAD Studio 10.2 Tokyo 中修复后的工作方式。此逻辑也适用于其他标头 -Accept, Accept-Charset, Accept-Encoding, User-Agent。修补方法TRESTHTTP.PrepareRequest实现起来稍微困难一些，因为它有private能见度。

最难的选择是修补TWinHTTPRequest.SetHeaderValue丢弃次要内容类型值。这也是最危险的一种，因为它会对任何与 HTTP 相关的内容（依赖于THTTPClient）在您的应用程序中。修补类也很困难，但并非不可能，因为它完全隐藏在implementation的部分System.Net.HttpClient.Win.pas。这是一个巨大的耻辱，因为它还阻止您创建自定义子类。也许有充分的理由..谁知道呢；）