swagger模式示例值中如何转义特殊字符?

时间:2019-06-12 16:19:18

标签: jackson yaml swagger openapi

在草率(3.0)定义YAML中,如果我具有带字符串属性的架构 并添加自定义示例值,例如<>&等特殊字符在浏览时显示为“错误”,例如<成为&lt;

我尝试使用\x3c代替<,或使用!!str前缀,但无济于事。

在这种情况下,响应为“ application / xml”,这可能是一个问题,但是在属性名称中,“-”号会完美显示(请参见下文)。

某些特殊字符可以正常工作,例如&

info:
  title: poc
servers:
- url: /poc/api
  variables: {}
paths:
  /ex2:
    get:
      tags:
      - example
      summary: debugging schema with example value contains < or >
      description:
      operationId: example
      responses:
        200:
          description: 
          content:
            application/xml;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/Wrapper'
components:
  schemas:
    Entry:
      type: object   
      properties:
        name:
           type: string
        value:
           type: number
    Wrapper:
      type: object   
      properties:
        entry:
           type: object
           $ref: '#/components/schemas/Entry'
        customfield:
           type: string
           example: "<hello\x3c"
        custom<>field:
           type: string
           example: "why"

0 个答案:

没有答案