Как я могу добавить xml пример в документации Swagger - PullRequest
Новая
       36

Как я могу добавить xml пример в документации Swagger

0 голосов
/ 06 марта 2020

Здравствуйте, я создаю документацию по swagger для API, и я хотел бы добавить пример xml, но я не могу этого сделать.

Это документация по swagger, которую я написал 

swagger: "2.0"
info:
  title: Documentatie API 
  description: Descriere documentatie API metode POST
  version: 1.0.0
host: xxx.ro
basePath: /v1
schemes:
  - https
paths:
  /stareMesaj:
    post:
      summary: Stare mesaj
      description: Descriere stare mesaj
      consumes:

            - application/xml
      produces:

            - application/xml
      responses:
        200:
          description: OK
          schema:
            type: object
            properties:
              id:
                type: integer
                example: 4
              name:
                type: string
                example: Arthur Dent

Я думал, что свойства в схеме преобразуются в примере, но он говорит: 

<?xml version="1.0" encoding="UTF-8"?>
<!-- XML example cannot be generated; root element name is undefined -->

Можете ли вы привести пример?

Заранее спасибо

1 Ответ

0 голосов
/ 06 марта 2020

Ваша встроенная схема не имеет имени, поэтому пользовательский интерфейс Swagger не знает, как назвать элемент root в XML.

Либо добавьте xml.name в вашу схему: 

      responses:
        200:
          description: OK
          schema:
            type: object
            properties:
              ...
            xml:           # <-----
              name: user

или определите именованную схему в разделе definitions и сделайте ссылку на нее: 

      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/user'

definitions:
  user:
    type: object
    properties:
      id:
        type: integer
        example: 4
      name:
        type: string
        example: Arthur Dent
...