Dify Workflow: Verabschieden Sie sich von umständlichem API-Docking, generieren Sie Code und Abfrageparameter mit einem Klick

Im digitalen Zeitalter sind APIs (Application Programming Interfaces) zum Eckpfeiler der Interaktion zwischen verschiedenen Softwaresystemen geworden. Allerdings sind traditionelle API-Schnittstellenmethoden oft ineffizient und frustrierend für Entwickler.

Standen Sie auch schon vor dem folgenden Dilemma?

• Dokumentation Skybook: Die Dokumentation der Schnittstelle ist unübersichtlich und die Parameterbeschreibungen sind vage und verwirrend.
• Terminologielabyrinth: Es gibt eine endlose Reihe von Fachbegriffen, und Anfänger müssen viel Zeit damit verbringen, Informationen zu konsultieren, um sie zu verstehen.
• Parametrische schwarze Löcher: Die komplexe API-Dokumentation enthält viele Parameter und eine schwindelerregende Anzahl von Konfigurationskombinationen.
• Verdoppelung der Arbeit: Jedes Mal, wenn Sie eine neue API verwenden, müssen Sie wiederholt die Dokumentation lesen, Code schreiben, debuggen und testen, was zeitaufwändig und arbeitsintensiv ist.

Diese Probleme verringern nicht nur die Entwicklungseffizienz, sondern erhöhen auch die F&E-Kosten der Unternehmen. Um diese Probleme zu lösen, hat Dify einen neuen Workflow eingeführt, der mithilfe von KI-Technologie den API-Andockprozess vereinfachen und Entwickler von mühsamer Dokumentationsarbeit befreien soll.

Dify Workflow: Der intelligente API-Assistent

Dify Workflows sind wie intelligente Assistenten, die die API-Dokumentation automatisch lesen und verstehen und sie in Code und Informationen umwandeln, die Entwickler leicht nutzen können. Im Kern nutzt es große KI-Modelle, um API-Dokumente semantisch zu analysieren und zu verarbeiten.

Der gesamte Prozess läuft wie folgt ab:

1. Extraktion von Dokumenten: Dify-Workflows unterstützen mehrere Quellen für die API-Dokumentation:
   • Lokale Dokumentation: Unterstützt das Hochladen von Dokumenten in Word, Markdown, PDF und anderen Formaten.

     

   • Online-Dokumentation: Unterstützt die Eingabe der URL eines API-Dokuments zur automatischen Erfassung des Inhalts einer Webseite.
   • API-Definitionsdatei: Unterstützt den direkten Import von API-Definitionsdateien im Swagger/OpenAPI-Format.
2. Page Crawl: Für die Online-API-Dokumentation integriert Dify das Open-Source-Tool Firecrawl, das Webinhalte in das Markdown-Format konvertiert.

   Firecrawl Offizielle Website: https://www.firecrawl.dev/

   

   Benutzer können sich auf der Firecrawl-Website registrieren, um einen API-Schlüssel zu erhalten und das entsprechende Plugin in Dify zu installieren.

   

   Dify unterstützt die Installation des Firecrawl-Plugins. Wer es sich leisten kann, kann es auch lokal einsetzen, da die Anzahl der kostenlosen Firecrawl-Credits begrenzt ist.

3. Verarbeitung von AI-Modellen: Übermitteln Sie den extrahierten Dokumentinhalt oder den gecrawlten Markdown-Text zur Verarbeitung an das KI-Makromodell.

   

   Dify-Workflows unterstützen eine große Auswahl an KI-Modellen. Tests haben ergeben, dassqwen2.5-coder-32b-instruct Modelle sind vor allem aus den folgenden Gründen eine gute Wahl:

   1. 128k Kontextfenster, ausreichend für die meisten API-Dokumente.
   2. Als Codemodell ist es besser geeignet, Aufgaben im Zusammenhang mit der Codegenerierung zu bewältigen.
   3. Alle wichtigen Modellierungsplattformen sind für einen einfachen Zugang verfügbar.
   4. Für Benutzer mit Hochleistungs-GPUs (z. B. 4090, 5090) ist die lokale Bereitstellung eine Option für eine schnellere Verarbeitung.

   

   Wenn Sie ein kleines Budget haben, können Sie sich natürlich auch für qwen2.5-coder-7b-instruct Modelle. Wenn die besten Ergebnisse angestrebt werden, muss diedeepseek-r1 Auch das Modellieren ist eine gute Option.

4. Kompatibilität: Dify-Workflows unterstützen die wichtigsten Betriebssysteme wie Windows, macOS und Linux und sind mit Python, Java, JavaScript, Go und anderen Programmiersprachen kompatibel.

Durch die oben genannten Schritte kann der Dify-Workflow API-Dokumente aus verschiedenen Quellen und Formaten in einheitliche Textdaten umwandeln, die von der KI verstanden werden können und die Grundlage für die anschließende Codegenerierung, Parameterabfrage und andere Funktionen bilden.

API-Dokumentation zur Codegenerierung: die Entwicklung der öffentlichen Nummer des Mikrokanals als Beispiel

Als nächstes wird am Beispiel der Entwicklung der öffentlichen WeChat-Nummer gezeigt, wie der Dify-Workflow den API-Andockprozess vereinfachen kann.

Der erste Schritt bei der Entwicklung von WeChat besteht in der Regel darin, ein Zugangstoken zu erhalten.

Die offizielle Dokumentation von WeChat: https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Get_access_token.html

Der traditionelle Entwicklungsprozess sieht in der Regel folgendermaßen aus:

1. Lesen Sie die Dokumentation, um die URL der Schnittstelle und die Anforderungsmethode zu finden.
2. Bestimmen Sie die für die Schnittstelle erforderlichen Parameter.
3. Suchen Sie in der Dokumentation nach Schlüsselparametern wie AppID und AppSecret.
4. Schreiben Sie Testcode.
5. Führen Sie den Code aus und debuggen Sie ihn.
6. Wenn ein Fehler auftritt, gehen Sie zurück zur Dokumentation, um die Ursache anhand des Fehlercodes zu ermitteln.

Mit Dify-Workflows kann der oben beschriebene Prozess stark vereinfacht werden. Geben Sie einfach die URL des API-Dokuments in die Dify-Workflow-Schnittstelle ein, wählen Sie eine Programmiersprache (z. B. Python) und klicken Sie auf Ausführen.

Dify parst automatisch das gesamte Dokument, interpretiert die genaue Bedeutung von Parametern und Fehlercodes und generiert lauffähige Codebeispiele.

Darüber hinaus gibt Dify direkt in den generierten Code-Kommentaren oder auf der Benutzeroberfläche Tipps, wie man Schlüsselparameter wie AppID und AppSecret erhält. Bei der Entwicklung von WeChat public beispielsweise wird Dify den Benutzer auffordern, zu "WeChat public platform's 'Settings and Development - Basic Configuration'" zu gehen, um diese zu erhalten.

Die Benutzer füllen einfach die "Extra Notes" des Dify-Workflows mit der AppID und dem AppSecret aus, die sie erhalten haben, und klicken ohne besondere Formatierung auf "Run", um brauchbaren Code zu erzeugen.

Kopieren Sie den generierten Code in eine IDE wie PyCharm und führen Sie ihn aus, um die APIs direkt aufzurufen. So entfällt die Notwendigkeit, große Mengen an Code manuell zu schreiben und mühsames Debugging durchzuführen.

Neben der Generierung von Testcode unterstützt Dify auch die Verwendung bestimmter Entwicklungsframeworks oder Bibliotheken. Bei der Java-Entwicklung können Sie zum Beispiel die weixin-java-mp Diese häufig verwendete WeChat-Entwicklungsbibliothek. Benutzer müssen nur eine Anfrage in Dify stellen, selbst wenn sie sich nicht an den vollständigen Namen der Bibliothek erinnern, kann Dify den entsprechenden Code generieren.

Darüber hinaus unterstützt Dify auch die Code-Vervollständigung. Benutzer können vorhandene Codeschnipsel in Dify kopieren, Dify vervollständigt den Code automatisch entsprechend dem Kontext, um die Entwicklungseffizienz zu verbessern.

Abfrage der API-Dokumentationsparameter

Neben der Codegenerierung bietet Dify Workflow auch eine leistungsstarke Parameterabfragefunktion. Benutzer können direkt im Dokument Fragen stellen, z. B. nach der Bedeutung eines Parameters. Besonders für Dokumente, die Pinyin-Initialen als Parameternamen verwenden, ist diese Funktion sehr nützlich.

Dify wird genaue Erklärungen geben, die auf dem Inhalt der Dokumentation basieren, damit die Benutzer schnell verstehen, wie die API zu verwenden ist.

Preisgestaltung und Zugang

Dify bietet sowohl kostenlose als auch kostenpflichtige Versionen an. Die kostenlose Version enthält grundlegende Funktionen und ist für einzelne Entwickler ausreichend. Die kostenpflichtige Version bietet fortgeschrittenere Funktionen und technischen Support und ist für Unternehmensanwender geeignet. Benutzer können sich auf der Dify-Website für eine kostenlose Testversion anmelden.

Um die neuen Workflows von Dify zu erleben, können Sie DSL-Dateien im Studio auf der Dify-Homepage finden und importieren.

Zusammenfassung und Ausblick

Der neue Workflow von Dify nutzt KI-Technologie, um API-Dokumente automatisch zu analysieren, Code zu generieren und Parameter abzufragen, wodurch der API-Andockprozess erheblich vereinfacht und die Entwicklungseffizienz verbessert wird. Sowohl Anfänger als auch erfahrene Entwickler können von Dify Workflow profitieren.

In Zukunft wird Dify die KI-Modelle weiter optimieren, um die Genauigkeit und Geschwindigkeit des Parsens von API-Dokumenten zu verbessern. Gleichzeitig wird Dify weitere Anwendungsszenarien erforschen, wie z. B. automatische API-Tests, API-Performance-Monitoring usw., um Entwicklern eine umfassendere, intelligentere API-Toolkette zur Verfügung zu stellen. Dify freut sich auf die Zusammenarbeit mit Ihnen, um einen intelligenteren und effizienteren Weg der Entwicklung zu finden.