Was ist der Vorteil der Verwendung von Spring-REST-Docs im Vergleich zu Stolzieren

Spring REST Docs wurde vor kurzem veröffentlicht und die Dokumentation sagt:

Dieser Ansatz befreit Sie von den Einschränkungen durch Werkzeuge wie Swagger

So, ich wollte mal Fragen, wenn der Frühling REST Docs ist vorzuziehen, im Vergleich zu Stolzieren und welche Einschränkungen es gibt.

  • Dies ist weitgehend die Meinung basiert, so dass ich nicht denke, es gehört auf Stack Overflow. Das sagte, vielleicht finden Sie diese Q&A auf DZone von Interesse sein.
InformationsquelleAutor evgeniy44 | 2015-12-24
  1. 24

    Sah ich gerade eine Präsentation, die hier berührt, auf Ihre Frage zu anderen Themen:

    https://www.youtube.com/watch?v=k5ncCJBarRI&t=26m58s

    • Swagger nicht unterstützt hypermedia überhaupt /ist es URI centric

    • Swagger ' s Methode der Inspektion kann der code hinter dem code. Es ist möglich, eine änderung in Ihrem code, dass Swagger nicht verstehen und nicht verarbeiten, richtig, bis Swagger wird aktualisiert.

    • Swagger erfordert viel annotation, und es ist schmerzhaft zu gehören den beschreibenden text, den Sie möchten in einen api-Dokument, in Anmerkungen.

    • Es gibt nur einige Dinge, dass Swagger nicht herausfinden können, von der überprüfung Ihres Codes.

    In jedem Fall, dies sind nur ein paar Punkte. Der Moderator ist viel besser diskutieren, als ich es könnte.

    InformationsquelleAutor Edgar Ngwenya
  2. 12

    Ich dachte, ich würde in Glockenspiel zu geben, ein bisschen mehr Kontext Swagger, was es ist und was es nicht ist. Ich glaube, das könnte helfen, deine Frage zu beantworten.

    Swagger 2.0 wird angenommen, dass durch eine Menge von großen Namen und großen Plattformen wie Microsoft Azure, Paypal, SwaggerHub.com, DynamicApis.com usw... Etwas im Auge zu behalten ist, dass Swagger ist sehr einfach ein-Spezifikation. Es ist nicht ein Rahmen. Es gibt eine Menge von frameworks draußen gebaut zu generieren Swagger Ausgabe, kriechen durch den code suchen Sie in Ihren API-Informationen, um zu bauen Fors 2.0 JSON-Datei für Ihr API. Die Swagger-UI, die sehen Sie Ihre APIs auf wird direkt angetrieben von dieser Swagger 2.0 JSON-Datei. fiddler ' es, check it out

    Es ist wichtig zu beachten, dass ein Rahmen, der geschaffen wurde, um Ihnen zu erlauben, bei "swagger" ist nicht, wie Swagger hat zu arbeiten (d.h. es ist völlig bis zu der Umsetzung des 3rd-party-framework). Wenn der Rahmen, den Sie verwenden, um zu generieren Ihre Swagger 2.0-Dokumente und UI ist nicht für Sie arbeiten, dann sollten Sie in der Lage sein zu gehen finden Sie einen anderen Rahmen, der erzeugt Selbstbewusstsein Artefakte und tauschen Technologien aus.

    Hoffe, das hilft.

    • Herzlich willkommen auf SO und vielen Dank für die Buchung eine Antwort. Haben Sie Zitate, die einbezogen werden können, als Teil Ihrer Antwort?
    • Danke. Ich habe tatsächlich mit SO für Jahre und Jahre, aber vor kurzem fingen an. Hier ist die Spezifikation guide auf swaggers Seite. stolzieren.io/Spezifikation. Überprüfen Sie heraus die ersten paar Absätze. Es gibt eine Menge von githb Projekte gibt, die verwendet werden können, zu generieren Ihr Selbstbewusstsein zu. Ich benutze Swashbuckle, denn ich bin eine .Net Kerl. Diese sind ein gutes Beispiel dafür, wie ein Rahmen tatsächlich funktioniert zu generieren, Fors-Spezifikation.
    • Bitte Bearbeiten Sie den link in Eure Antwort 🙂
    InformationsquelleAutor Jerrod Horton
  3. 5

    Gibt es einige Einschränkung mit swagger und den spezifischen Feder-stack.

    Beispiel : mit "param" in Ihrer Anfrage-Mapping können Sie festlegen, mehr als eine Methode mit dem selben url und so den code vereinfachen.
    Aber swagger zeigen Sie nur eine Methode

    • Vielleicht ist die Frage zu allgemein ist, aber ich denke, diese Antwort ist zu kurz für solch eine komplexe Frage.
    InformationsquelleAutor Sbert
  4. 1

    Vom Spring REST docs:

    Dem Ziel, Spring REST-Docs ist, Ihnen zu helfen, produzieren die Dokumentation für Ihre RESTful-Dienste, die korrekt und lesbar

    Diese test-driven-Ansatz hilft, um Gewähr für die Richtigkeit der Ihr service-Dokumentation. Wenn ein snippet ist falsch, der test, die es produziert, wird scheitern.

    Spring REST docs Vorteile:

    • Dokumentation ist schriftlich in den test-code, so dass es nicht überlastet main-code mit vielen Anmerkungen und Beschreibungen
    • Generiert docs und Beispiele sind korrekt, weil Verwandte test passieren muss
    • Docs kann mehr spezifischen und aussagekräftigen snippets
    • - Format ist geeignet für die Veröffentlichung

    Spring REST docs Nachteile:

    • Mehr Arbeit erfordert
    • Dokumentation bietet Anfrage - /Antwort-Beispielen, aber nicht auf interaktive tools zu ändern und ausprobieren, Anfragen

    Swagger Vorteile:

    • Schnelle, automatisierte Erzeugung von einem code
    • Interaktive Anfrage-Ausführung - kann verwendet werden, für die Abnahme
    • Gebaut, um die Open API Spezifikation

    Swagger Nachteile:

    • Weitere beschreibende Dokumentation es erfordert eine Menge von Annotationen
    • Tests nicht im Zusammenhang mit der Dokumentation, so dass manchmal-Dokumentation abweichen von der Realität
    InformationsquelleAutor Justas
  5. 0

    Einen Nachteil mit Swagger ist: es nicht in den Griff-Modellen, die eine zyklische Abhängigkeiten. Wenn Sie ein Modell hat zyklische Abhängigkeit und wenn swagger aktiviert ist, dann spring boot-server stürzt ab.

    InformationsquelleAutor user1702260
Schreibe einen Kommentar