2016-03-18 14 views
4

Ich bin besorgt auf der Generierung von Modell/Beispielwert Abschnitt für meine GET-Anforderung mit Swagger zu erzeugen. The link zu offiziellen Beispiel zeigt diesen Abschnitt perfekt.Wie Modell/Beispielwert Abschnitt für GET-Anforderung in Swagger

In offiziellen docs es erzeugt wird, indem bestehende Modell:

 *  @SWG\Schema(ref="#/definitions/User") 

Ich habe keine solche Option, weil meine Eigenschaften von REST erzeugt wird.

Ich habe die folgende Art und Weise versucht:

/** 
* @SWG\Get(
... 
*  @SWG\Response(
*   response="200", 
*   description="Ok", 
*   @SWG\Schema(
*    type="array", 
*    @SWG\Property(property="firstname", type="string", example="Steven") 
*  ), 
* ), 
*) 
*/ 

Es funktioniert nicht und Antworten:

fetching resource list: http://localhost/dist/swagger.json; Please wait.

Jede Hilfe sehr geschätzt wird. Danke im Voraus.

Antwort

4

Die GET /pet/findByStatus wird in einem der Beispiele generiert:
github.com/zircote/swagger-php/.../Examples/petstore.swagger.io/controllers/PetController.php

Der Grund Ihrer Snippet funktioniert nicht, weil Sie eine Eigenschaft auf eine array Art sind das Hinzufügen, die nicht unterstützt wird.

Um den Inhalt des Arrays beschreiben Sie die @SWG\Items Anmerkung benötigen:

... 
*   @SWG\Schema(
*    type="array", 
*    @SWG\Items(
*     type="object", 
*     @SWG\Property(property="firstname", type="string", example="Steven") 
*   ) 
*  ), 
... 
+0

Danke für die Antwort. Erfolgreich ohne Artikel, es musste nur den Typ von Array zu Objekt ändern. – Bandydan