Как экранировать специальные символы в значениях примера схемы swagger? - PullRequest
Новая
       45

Как экранировать специальные символы в значениях примера схемы swagger?

0 голосов
/ 12 июня 2019

В определении swamger (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"
...