Ich bin neu in diesem Zeug, aber ich liebe es. Ich habe mit dem Slim Framework ein kleines REST Api gemacht. Jetzt hätte ich gerne eine laufende Dokumentation darüber. Ich denke, Swagger ist die richtige Wahl, aber ich habe noch nicht herausgefunden, wie man es integriert?RESTful API Doc mit SLIM und SWAGGER?
Prost & Dank für Ihre Geduld :)
Ich glaube, Sie für dieses Projekt suchen: zircote/swagger-php
Here Sie werden feststellen, wie das Dokument auf Benutzeranforderung an einen URL zu generieren.
Grundsätzlich müssen Sie Ihren Code mit den Swagger Anmerkungen Anmerkungen versehen, dann mit einem Code einen anderen Weg in dünner erstellen ähnlich wie diese:
<?php
use Swagger\Swagger;
$swagger = new Swagger('/project/root/top_level');
header("Content-Type: application/json")
echo $swagger->getResource('/pet', array('output' => 'json'));
Und es wird die Swagger API-Dokumentation on the fly für Sie generieren.
danke! aber wie integriere ich dann die swagger-UI? – user2942586
hat es aufgemacht und läuft :) – user2942586
@ user2942586 Würdest du so freundlich sein zu erklären, wie du es in Gang gebracht hast? – LeonardChallis
Ich habe gute Dinge über Swagger gehört - gibt es Dokumente auf der zugehörigen Website? Ich denke jedoch, dass dieses Thema hier zu weit gefasst ist - bedenken Sie, dass Stack Overflow für die Programmierung von Code-Problemen gedacht ist. Wenn Sie es ausprobieren und diese Frage über _what_ bearbeiten können, wäre das großartig. – halfer
Ich weiß nicht, wie ich Swagger in mein PHP-Projekt integrieren kann. Sie bieten einen PHP-Client auf Github und ein Server-Integrations-Tutorial für Java, aber das hat mich nicht weiter gebracht. Im Moment habe ich keine Ahnung welche Schritte ich machen muss. Ich möchte keine Kommentare in meine Quelle einfügen und dann ein Tool ausführen, das eine Dokumentation erstellt. – user2942586