为什么XML文件在Swagger中变成紫色代码？我的代码有什么问题

问题描述 投票：0回答：1

我正在尝试获取要在 Swagger UI 中显示的 xml 请求正文。然而，这就是我得到的：

enter image description here

这是我想要的文档：

<doc><members> ..... !--5. UpdCom1 -->
    <br>
        <member name="UpdCom1">
            <summary>
                5. 修改賽事資料1-基本資料             </summary>
            <param name="ReqUpdCom1">
                包含 許多比賽其本資料 格式如下：
                
                <br></br>
                <code>TID   [string]</code> - 球隊編號
                
                <br></br>
                <code>CID   [string]</code> - 賽事編號
                
                <br></br>
                <code>CName   [string]</code> - 賽事名稱
                
                <br></br>
                <code>CType   [int]</code> - 賽事類型
                
                <br></br>
                <code>CSubject   [string]</code> - 比賽主旨
                
                <br></br>
                <code>Organizer1   [int]</code> - 主辦單位
                
                <br></br>
                <code>Organizer2   [string]</code> - 承辦單位
                
                <br></br>
                <code>Directed   [int]</code> - 協辦單位
                
                <br></br>
                <code>Co_Organizer   [int]</code> - 協辦單位
                
                <br></br>
                <code>CStartDate   [string]</code> - 賽事開始日期
                
                <br></br>
                <code>CEndDate   [string]</code> - 賽事結束日期
                
                <br></br>
                <code>FID1   [string]</code> - 第1球場編號/名稱
                
                <br></br>
                <code>Fairways1   [int]</code> - 道數1
                
                <br></br>
                <code>FID2   [string]</code> - 第2球場編號/名稱
                
                <br></br>
                <code>Fairways2   [int]</code> - 道數2
                
                <br></br>
                <code>Eligibility   [string]</code> - 參賽資格
                
                <br></br>
                <remarks>
                    <para>Sample Request:</para>
                    <para>POST /Account/ReqUpdCom1</para>
                    <br></br>
                    {
                    <br></br>
                      "tid": "T2000010101",
                    <br></br>
                      "cid": "C2023121100001",
                    <br></br>
                      "cName": "測試比賽A
                    <br></br>
                      "cType": 1
                    <br></br>
                      "cSubject": "Test11
                    <br></br>
                      "organizer1": "Test22",
                    <br></br>
                      "organizer2": "Test33",
                    <br></br>
                      "directed": "Test44",
                    <br></br>
                      "co_Organizer": "Test55",
                    <br></br>
                      "cStartDate": "2023-12-21",
                    <br></br>
                      "cEndDate": "2023-12-22",
                    <br></br>
                      "fiD1": "F0001",
                    <br></br>
                      "fairways1": 12,
                    <br></br>
                      "fiD2": "",
                    <br></br>
                      "fairways2": 0,
                    <br></br>
                      "eligibility": "台北資格"
                    <br></br>
                    }
                    <br></br>
                </remarks>
            </param>
            <returns>返回包含 State狀態 與 訊息</returns>
            <response code="200">
                回傳:
                
                <para>
                    <c>state  [string]</c> - 狀態
                
                </para>
                <para>
                    <c>Msg [string]</c> - 訊息
                
                </para>
                <remarks>
                    <para>
                        <b>Sample Status200 Responses:</b>
                    </para>
                [ 
                    <br></br>
                { 
                    <br></br>
                "state": "OK", 
                    <br></br>
                "msg": "修改成功~" 
                    <br></br>
                } 
                    <br></br>
                ] 
                    <br></br>
                </response>
            </member>
        </members>
    </doc>

为什么会创建如图所示的全紫色块？我错过了什么吗？如果有任何疑问，请随时询问，谢谢

我有任何API，其代码与上面的代码基本相同，但它显示正确，如下图所示（图片B），因为我也希望我的图片A代码看起来像这样

enter image description here

xml swagger-ui
1个回答
0
投票

您的 XML 不 格式良好。 为了使其格式良好，请进行以下更正：

  1. 关闭
    <br>
    标签。
  2. 关闭
    <remarks>
    标签。

这是应用了之前的更正和格式调整的 XML：

<doc>
  <members> ..... !--5. UpdCom1 -->
    <br></br>
    <member name="UpdCom1">
      <summary>
      5. 修改賽事資料1-基本資料             </summary>
      <param name="ReqUpdCom1">
        包含 許多比賽其本資料 格式如下：
        
        <br></br>
        <code>TID   [string]</code> - 球隊編號
        
        <br></br>
        <code>CID   [string]</code> - 賽事編號
        
        <br></br>
        <code>CName   [string]</code> - 賽事名稱
        
        <br></br>
        <code>CType   [int]</code> - 賽事類型
        
        <br></br>
        <code>CSubject   [string]</code> - 比賽主旨
        
        <br></br>
        <code>Organizer1   [int]</code> - 主辦單位
        
        <br></br>
        <code>Organizer2   [string]</code> - 承辦單位
        
        <br></br>
        <code>Directed   [int]</code> - 協辦單位
        
        <br></br>
        <code>Co_Organizer   [int]</code> - 協辦單位
        
        <br></br>
        <code>CStartDate   [string]</code> - 賽事開始日期
        
        <br></br>
        <code>CEndDate   [string]</code> - 賽事結束日期
        
        <br></br>
        <code>FID1   [string]</code> - 第1球場編號/名稱
        
        <br></br>
        <code>Fairways1   [int]</code> - 道數1
        
        <br></br>
        <code>FID2   [string]</code> - 第2球場編號/名稱
        
        <br></br>
        <code>Fairways2   [int]</code> - 道數2
        
        <br></br>
        <code>Eligibility   [string]</code> - 參賽資格
        
        <br></br>
        <remarks>
          <para>Sample Request:</para>
          <para>POST /Account/ReqUpdCom1</para>
          <br></br>
          {
          <br></br>
          "tid": "T2000010101",
          <br></br>
          "cid": "C2023121100001",
          <br></br>
          "cName": "測試比賽A
          <br></br>
          "cType": 1
          <br></br>
          "cSubject": "Test11
          <br></br>
          "organizer1": "Test22",
          <br></br>
          "organizer2": "Test33",
          <br></br>
          "directed": "Test44",
          <br></br>
          "co_Organizer": "Test55",
          <br></br>
          "cStartDate": "2023-12-21",
          <br></br>
          "cEndDate": "2023-12-22",
          <br></br>
          "fiD1": "F0001",
          <br></br>
          "fairways1": 12,
          <br></br>
          "fiD2": "",
          <br></br>
          "fairways2": 0,
          <br></br>
          "eligibility": "台北資格"
          <br></br>
          }
          <br></br>
        </remarks>
      </param>
      <returns>返回包含 State狀態 與 訊息</returns>
      <response code="200">
        回傳:
        
        <para>
          <c>state  [string]</c> - 狀態
          
        </para>
        <para>
          <c>Msg [string]</c> - 訊息
          
        </para>
        <remarks>
          <para>
            <b>Sample Status200 Responses:</b>
          </para>
          [ 
          <br></br>
          { 
          <br></br>
          "state": "OK", 
          <br></br>
          "msg": "修改成功~" 
          <br></br>
          } 
          <br></br>
          ] 
          <br></br>
        </remarks>
      </response>
    </member>
  </members>
</doc>

如果您的应用程序对缩进调整很敏感，请忽略 XML 的此重新格式化版本，并将所描述的更正按原样直接应用于您的副本，以单独更正格式良好的问题。

最新问题
© www.soinside.com 2019 - 2024. All rights reserved.