2016-04-21 16 views
0

Ist es möglich, das Auswahlfeld Antwort-Inhaltstyp hinzuzufügen, ohne das Schema Antwortklasse (Status 200) zu erstellen?Swagger-UI Response Inhaltstyp

Meine Webdienste geben JSON- oder XML-Format zurück, abhängig vom akzeptierten Header. Ich brauche dieses Drop-down danach.

Antwort

1

Sie können den Wert für den ‚Antwort Content Type‘ Drop-Down mit der produces Eigenschaft der Swagger Definition füllen:

--- 
swagger: '2.0' 
info: 
    version: 0.0.0 
    title: Simple API 
produces: 
    - application/xml 
    - application/json 
paths: 
    /: 
    get: 
     responses: 
     200: 
      description: OK 

Sie schließlich benötigen Sie ein Antwort-Schema als auch zu definieren, aber diese Definition kann unabhängig vom Typ des Antwortinhaltes sein (json vs xml).

+0

können Sie mir bitte sagen, wenn meine API json Daten zurückgibt, so was wäre die Annotation für xml und json beide Content-Typ bekommen? –

+1

Wenn Ihre API nur json-Daten zurückgibt, geben Sie einfach die json-Zeile in 'products' an. Wenn Sie entweder json oder xml erstellen können, verwenden Sie das obige Beispiel. – anyarms

+1

In der Steuerung, wie erhalten Sie, welche Antwort Content-Typ ausgewählt ist? – user1930591