Fors-PHP für die Generierung der JSON-Datei für Swagger-UI

Ich bin versucht, Fors-PHP für die Generierung von JSON-Dateien , so dass ich es verwenden können, mit Swagger-UI für die automatische Dokumentation.

Ich habe versucht den link :- https://github.com/zircote/swagger-php

Auch habe ich versucht zu umgehen mit der Dokumentation im http://zircote.com/swagger-php/installation.html

Aber mein großes Glück , ich bin nicht in der Lage, es zu implementieren.

Ich bin in der Lage zu installieren Komponist korrekt.
Auch das bundle von Fors-PHP richtig installiert ist.

Aber das problem ist, dass ich bin nicht in der Lage zu verwenden/zu verstehen, die test-Beispiele zur Verfügung gestellt.

Also wenn jemand gearbeitet hat, ihn um Hilfe bitte !!

Vielen Dank im Voraus !!

Hallo zusammen kann man mehr details bitte? Wie das, was Fehler, die Sie bekommen. Das wird hilfreich sein.

InformationsquelleAutor user1496197 | 2013-05-03

  1. 10

    Sind Sie einfach nur Kommentare aka Anmerkungen im code, Modell-Beispiel:

    /**
* @SWG\Model(
* id="vps",
* required="['type', 'hostname']",
*  @SWG\Property(name="hostname", type="string"),
*  @SWG\Property(name="label", type="string"),
*  @SWG\Property(name="type", type="string", enum="['vps', 'dedicated']")
* )
*/
class HostVps extends Host implements ResourceInterface
{
    //...
}

    Controller Beispiel:

    /**
 * @SWG\Resource(
 *  basePath="http://skyapi.dev",
 *  resourcePath="/vps",
 *  @SWG\Api(
 *   path="/vps",
 *   @SWG\Operation(
 *    method="GET",
 *    type="array",
 *    summary="Fetch vps lists",
 *    nickname="vps/index",
 *    @SWG\Parameter(
 *     name="expand",
 *     description="Models to expand",
 *     paramType="query",
 *     type="string",
 *     defaultValue="vps,os_template"
 *    )
 *   )
 *  )
 * )
 */
 class VpsController extends Controller
 {
     //...
 }

    Dann in der Konsole:

    php swagger.phar ./your-code-source/ -o ./directory-for-output-files

    Dann erzeugten link-Dateien in Swagger-UI.
    Ist diese Hilfe?

    BTW, diese Dokumentation: http://zircote.com/swagger-php/annotations.html ist unvollständig. Es ist besser, sich auf parser-Fehler, Beispiel:

    php swagger.phar ./skynode-api/api/ -o ./foo
Swagger-PHP 0.9.0
-----------------
[INFO] Skipping unsupported property: "foo" for @Swagger\Annotations\Property, expecting "name", "description", "type", "format", "items", "uniqueItems", "required", "minimum", "maximum", "enum", "defaultValue", "_partialId", "_partials" in HostVps in /home/kane/some-dir/some-file.php on line 3

    BEARBEITEN: Swagger 2.0 hat ziemlich gute Spezifikation auf GitHub

    BTW, betrachten Sie zu verwenden Swagger-Editor zu erstellen, api specification Datei (json/yaml) für die Verwendung in Swagger-UI. Ursache inline-SWG-Dokumentation bei php-Dateien ist einfach nur hässlich, und Sie haben nicht AutoVervollständigen-Unterstützung in der IDE.

    Wäre es nicht cool, wenn Sie verwenden könnte, Fors-Editor yaml in den Anmerkungen, so dass der inline-Dokumentation ist nicht so hässlich?

    InformationsquelleAutor TomaszKane

  2. 0

    Habe ich gekämpft, auf das man in letzter Zeit sehen einige Unterschiede und es geschafft es zum laufen zu bringen und wollte vielleicht Verknüpfung jemand anderes:

    //In the controller

/**
 * (other swagger stuff like @SWG\Put, etc...)
 *   @SWG\Parameter(name="type",in="path",description="project|task",
 *                  required=true, type="array",             
 *                  @SWG\Items(type="string"), 
 *                  default="project",
 *                  enum={"project", "task"}),
 * (next @SWG\Parameter or closing paran, etc)
 */

    Ich hatte davor bekommen diese arbeiten mit enum in das Modell und eine @SWG\Items Verweis auf es, aber nicht speichern, code (ich war nur Herumspielen), und ich kann es nicht zurückbekommen. Ich selbst sehe die ich bisher von Ihnen positiv bewertet werden die Frage und die Antwort akzeptiert! Aber das oben genannte ist die einzige Art, wie ich bekommen kann, es funktioniert jetzt und ist besser als nichts.

    InformationsquelleAutor Hans

Schreibe einen Kommentar