Question

我有一个API调用，如果发件人将Accept标头设置为text/plain，我想提供该API调用作为人类可读文本（相对于json）返回。返回文本将带有换行符，因此我想在招摇的文档中准确表示返回文本模板。

我正在使用带有.yaml文件的静态swagger文件，并在编写每个端点时对其进行更新。这些文件位于docs文件夹中，并用于github页面。

.yaml文件中所述的端点的粗略示例：

  /healthcheck:
    get:
      tags:
      - tests
      summary: Returns ALIVE if all tests pass, failures if not
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
               type: string
               example: ALIVE
        '412':
          description: Precondition Failed (one or more health checks failed)
          content:
            text/plain:
              schema:
                type: string
                example: "\n>ERRORS\nError1: <msg>\n..."

根本问题是（我假设）大张旗鼓地将示例文本放到一个跨度中，而忽略了换行符。我尝试用\n和<br>替换<br />无济于事。我也尝试过

example: |
  ERRORS
  "Error connecting to redis: <errormsg>"

没有成功。它很荣幸在字面上加上引号，但仍然忽略换行符。

我知道跨度将支持换行符，因为如果我检查页面，我已经可以在其中看到<br>：

<span style="color: rgb(107, 107, 107); font-style: italic;">
<br>
<!-- react-text: 309 -->example<!-- /react-text -->
<!-- react-text: 310 -->: <!-- /react-text -->
<!-- react-text: 311 --><br>ERRORS<br>Error1: &lt;msg&gt;<br>...
<!-- /react-text -->
</span>

它优先使用第一个<br>，而不是react-text块中的那些。

长话短说，如果我能找到他们在swagger文件（一堆.css，.js。.js.map文件）中创建此span块的位置，我可能可以对其进行修改以采用一种换行符来纪念换行符，或者另一个。但是这些文件只是一堆多页的一小段文本，我对它们没有任何意义。

在哪里找到用于创建content-> text / plain-> schema的html块的代码块，键入string->示例？（或者在字符串示例中，还有另一种强制换行的方法）

swagger文件中生成的响应字符串示例在哪里？

0 个答案: