Ist das inländische API-Management-Tool Apifox einfach zu verwenden?

Als Praktiker in der Softwareentwicklung ist das API-Debugging eine wesentliche Fähigkeit, und Postman leistet in dieser Hinsicht hervorragende Arbeit. Im gesamten Softwareentwicklungsprozess ist das API-Debugging jedoch nur ein Teil davon. Es gibt immer noch viele Dinge, die Postman nicht oder nicht effizient abschließen kann, wie zum Beispiel: API-Dokumentdefinition, API-Mock, automatisierte API-Tests usw. Apifox wurde geboren, um dieses Problem zu lösen.

Aktueller Status der Schnittstellenverwaltung

1. Verwenden Sie Swagger, um API mit MockJs und anderen Tools zu debuggen

4 automatisierte API-Tests durchzuführen

2. Probleme

Es ist sehr schwierig und ineffizient, die Datenkonsistenz zwischen verschiedenen Tools aufrechtzuerhalten. Dabei handelt es sich nicht nur um ein Problem der Arbeitsbelastung, das größere Problem ist die Inkonsistenz der Daten zwischen mehreren Systemen, was zu ineffizienter Zusammenarbeit, häufigen Problemen und miserablen Entwicklungen und Testern führt.

Nachdem Entwickler das Dokument in Swagger definiert haben, müssen sie zu Postman gehen, um es beim Debuggen der Schnittstelle erneut zu definieren. Wenn Sie Mock-Daten im Frontend entwickeln, müssen Sie diese erneut in MockJs definieren und Mock-Regeln manuell festlegen. Tester müssen zu JMeter gehen und es erneut definieren. Das Frontend wurde auf Basis der Daten von MockJs Mock entwickelt, und das Backend wurde auf Basis des von Swagger definierten Schnittstellendokuments entwickelt. Ich dachte, es könnte sofort online gehen Während der Verbindung wurden Probleme entdeckt: Die Schnittstelle wurde während des Entwicklungsprozesses geändert, MockJs wurde jedoch nicht rechtzeitig geändert. Die vom Back-End entwickelten Schnittstellendatentypen und Dokumente sind inkonsistent, was es schwierig macht, Probleme mit bloßem Auge zu erkennen. Ebenso werden in JMeter geschriebene Testfälle bei der tatsächlichen Ausführung verschiedene Inkonsistenzen feststellen. Mit der Zeit werden verschiedene Ungereimtheiten immer gravierender.

Apifox-Lösung:

Download-Adresse

1. So lösen Sie diese Probleme

1. Apifox-Positionierung

Apifox = Postman + Swagger + Mock + JMeter

Apifox ist API-Dokumentation, API-Debugging, API Mock, integrierte Plattform für die Zusammenarbeit mit automatisierten API-Tests. Lösen Sie das Problem der Datensynchronisation zwischen mehreren Systemen durch ein System und ein Datensystem. Solange das Schnittstellendokument definiert ist, können Schnittstellen-Debugging, Daten-Mocking und Schnittstellentests direkt verwendet werden, ohne dass es erneut definiert werden muss. Nach Abschluss des Schnittstellen-Debuggings kann dasselbe Tool für die Schnittstellendokument- und Schnittstellenentwicklung verwendet werden garantiert, dass es vollständig mit der Definition des Schnittstellendokuments übereinstimmt. Effizient, pünktlich und präzise!

2. Der Zweck von Apifox

Sparen Sie jede Minute des Forschungs- und Entwicklungsteams!

3. Apifox-Funktion

Schnittstellendesign: Während Apifox-Schnittstellendokumente den OpenApi 3.0- (ehemals Swagger) und JSON-Schema-Spezifikationen folgen, bietet es auch sehr benutzerfreundliche visuelle Dokumentverwaltungsfunktionen ohne Lernkosten und ist sehr effizient. Und unterstützt die Online-Freigabe von Schnittstellendokumenten. Datenmodell: Eine wiederverwendbare Datenstruktur, auf die beim Definieren der Schnittstellenrückgabedatenstruktur und der Anforderungsparameterdatenstruktur direkt verwiesen werden kann (nur JSON- und XML-Modi). Unterstützt direkte verschachtelte Referenzen von Modellen, direkten intelligenten JSON/XML-Import und unterstützt erweiterte Kombinationsmodi wie oneOf und allOf. Schnittstellen-Debugging: Apifox verfügt über Funktionen wie Postman, z. B. Umgebungsvariablen, Pre-/Post-Skripte, globale Cookie-/Sitzungsfreigabe usw., und ist effizienter und einfacher zu verwenden als Postman. Klicken Sie nach dem Ausführen der Schnittstelle auf die Schaltfläche „Als Anwendungsfall speichern“, um den Schnittstellen-Anwendungsfall zu generieren. Sie können den Schnittstellen-Anwendungsfall direkt ausführen, ohne Parameter einzugeben, was sehr praktisch ist. Benutzerdefinierte Skripte sind zu 100 % mit der Postman-Syntax kompatibel und unterstützen die Ausführung von Javascript, Java, Python, PHP, JS, BeanShell, Go, Shell, Ruby, Lua und anderen Sprachcodes. Anwendungsfälle für Schnittstellen: Normalerweise verfügt eine Schnittstelle über mehrere Anwendungsfälle, z. B. Anwendungsfälle für korrekte Parameter, Anwendungsfälle für falsche Parameter, Anwendungsfälle für leere Daten, Anwendungsfälle für unterschiedliche Datenstatus usw. Die Datenkorrektheit wird beim Ausführen von Schnittstellenanwendungsfällen automatisch überprüft. Es ist sehr effizient, Schnittstellenanwendungsfälle zum Debuggen von Schnittstellen zu verwenden. Schnittstellendaten-Mock: Die integrierte Mock.js-Regel-Engine ist sehr praktisch zum Mock-out verschiedener Daten, und Sie können Mock-Regeln schreiben, während Sie die Datenstruktur definieren. Unterstützt das Hinzufügen von „Erwartungen“, um unterschiedliche Scheindaten basierend auf Anforderungsparametern zurückzugeben. Das Wichtigste ist, dass Apifox sehr benutzerfreundliche Daten ohne Konfiguration simulieren kann, was später in diesem Artikel vorgestellt wird. Datenbankbetrieb: Unterstützt das Lesen von Datenbankdaten und deren Verwendung als Schnittstellenanforderungsparameter. Unterstützt das Lesen von Datenbankdaten, um zu überprüfen (zu bestätigen), ob die Schnittstellenanforderung erfolgreich ist. Automatisierte Schnittstellentests: Bietet Schnittstellensammlungstests und Sie können schnell einen Testsatz erstellen, indem Sie eine Schnittstelle (oder einen Schnittstellenanwendungsfall) auswählen. Derzeit befinden sich noch weitere Funktionen zum Testen der Schnittstellenautomatisierung in der Entwicklung, also bleiben Sie dran! Das Ziel ist: JMeter wird grundsätzlich über alle Funktionen verfügen und benutzerfreundlicher sein. Schnelles Debuggen: Eine Schnittstelle-Debugging-Methode ähnlich wie Postman. Ihr Hauptzweck besteht darin, einige Schnittstellen, die keine Dokumentation erfordern, schnell zu debuggen, ohne die Schnittstelle im Voraus zu definieren. Codegenerierung: Basierend auf der Definition der Schnittstelle und des Datenmodells generiert das System automatisch den Schnittstellenanforderungscode, den Front-End-Geschäftscode und den Back-End-Geschäftscode. Teamzusammenarbeit: Apifox wurde für die Teamzusammenarbeit entwickelt. Die Schnittstelle wird synchron in Echtzeit in der Cloud aktualisiert, und eine ausgereifte Team-/Projekt-/Mitgliedsrechteverwaltung erfüllt die Anforderungen aller Arten von Unternehmen.

2. Apifox leistet mehr als nur Datenintegration

Wenn Sie glauben, dass Apifox nur Datenintegration durchführt, um die Effizienz des Forschungs- und Entwicklungsteams zu verbessern, liegen Sie falsch. Apifox hat auch viele Innovationen vorgenommen, um die Entwicklereffizienz zu verbessern.

1. Die Schnittstelle unterstützt „Use-Case-Management“

Normalerweise verfügt eine Schnittstelle über mehrere Anwendungsfälle, z. B. Anwendungsfälle für korrekte Parameter, Anwendungsfälle für leere Daten und Anwendungsfälle für unterschiedliche Datenstatus. Definieren Sie diese Anwendungsfälle für verschiedene Zustände beim Definieren der Schnittstelle und führen Sie sie direkt beim Debuggen der Schnittstelle aus, was sehr effizient ist.

2. „Datenmodell“-Definition und Referenz

Das Datenmodell kann unabhängig definiert werden, wenn die Schnittstelle definiert wird, und die Datenmodelle können auch aufeinander verweisen. Dieselbe Datenstruktur muss nur einmal definiert werden und kann beim Ändern an mehreren Stellen verwendet werden. Sie müssen nur eine Stelle ändern, und mehrere Stellen werden in Echtzeit aktualisiert, um Inkonsistenzen zu vermeiden.

3. Datenstruktur beim Debuggen automatisch überprüfen

Bei Verwendung der Apifox-Debugging-Schnittstelle überprüft das System automatisch, ob die zurückgegebene Datenstruktur gemäß der Definition im Schnittstellendokument korrekt ist, ohne dass eine visuelle Erkennung erforderlich ist oder Das manuelle Schreiben von Assertionsskripten zur Erkennung ist sehr effizient! „Apifox überprüft automatisch die Datenstruktur.“ „Visualisierung " Extraktionsvariablen festlegen

6. Datenbankoperationen unterstützen

7. „Null-Konfiguration“-Mock erzeugt sehr benutzerfreundliche Daten

Lassen Sie uns zunächst ein Bild einfügen, um das Null-Konfigurations-Mock zu vergleichen Der resultierende Dateneffekt:

Apifox Mock-Datenergebnisse werden mit ähnlichen Tools verglichen

Es ist ersichtlich, dass die von Apifox Zero-Configuration Mock generierten Daten der tatsächlichen Situation sehr nahe kommen. Frontend-Entwickler können es direkt verwenden, ohne manuell Scheinregeln schreiben zu müssen.

Wie Apifox sehr benutzerfreundliche Scheindaten mit hoher Effizienz und ohne Konfiguration generieren kann

Apifox generiert automatisch Scheinregeln basierend auf der Datenstruktur und dem Datentyp in der Schnittstellendefinition. Apifox verfügt über eine integrierte intelligente Mock-Regelbibliothek, die automatisch generierte Mock-Regeln basierend auf Feldnamen und Felddatentypen intelligent optimiert. Beispiel: Ein Feld vom Typ „String“, dessen Name die Zeichenfolge „Bild“ enthält, wird automatisch eine Bildadressen-URL vortäuschen; ein Stadtname. Basierend auf integrierten Regeln kann Apifox automatisch Felder wie Bilder, Avatare, Benutzernamen, Mobiltelefonnummern, Website-Adressen, Datumsangaben, Uhrzeiten, Zeitstempel, E-Mail-Adressen, Provinzen, Städte, Adressen, IPs usw. identifizieren und so verspotten sehr benutzerfreundliche Daten. Zusätzlich zu den integrierten Scheinregeln können Benutzer die Regelbibliothek auch anpassen, um verschiedene personalisierte Anforderungen zu erfüllen. Unterstützt die Verwendung regulärer Ausdrücke und Platzhalter, um Feldnamen mit benutzerdefinierten Scheinregeln abzugleichen.

8. Online-Schnittstellendokumente generieren

Das Apifox-Projekt kann API-Dokumente online „teilen“. Die freigegebenen API-Dokumente können auf öffentlich eingestellt werden oder einen Passwortzugriff erfordern, was für die Zusammenarbeit mit externen Teams sehr praktisch ist.

Erfahrungsadresse: https://www.apifox.cn/apidoc/shared-ce387612-cfdb-478a-b604-b96d1dbc511b/http/5041285

9. Automatische Codegenerierung

Laut Schnittstellenmodelldefinition, automatische Generierung von Geschäftscode (z. B. Modell, Controller, Komponententestcode usw.) und Schnittstellenanforderungen in verschiedenen Sprachen/Frameworks (z. B. TypeScript, Java, Go, Swift, ObjectiveC, Kotlin, Dart, C++, C# , Rust usw.) Code. Apifox unterstützt derzeit die automatische Codegenerierung für 130 Sprachen und Frameworks.

Was noch wichtiger ist: Sie können benutzerdefinierte Codevorlagen verwenden, um Code zu generieren, der den Architekturspezifikationen Ihres Teams entspricht, um verschiedene personalisierte Anforderungen zu erfüllen.

10. Importieren, Exportieren

Unterstützt den Export von OpenApi- (Swagger), Markdown-, HTML- und anderen Datenformaten. Da Daten im OpenApi-Format exportiert werden können, können Sie die umfangreichen ökologischen Tools von OpenApi (Swagger) verwenden, um verschiedene Schnittstellen zu vervollständigen -bezogene Aufgaben sind wichtig. Unterstützt den Import von OpenApi (Swagger), Postman, apiDoc, HAR, RAML, RAP2, YApi, Eolinker, NEI, DOClever, ApiPost, Apizza, ShowDoc, API Blueprint, I/O Docs, WADL, Google Discovery und anderen Datenformaten zur Erleichterung alter Projekte migrieren. Unterstützt den geplanten automatischen Import von Daten im OpenApi- (Swagger-), APIDoc- und Apifox-Format.

3. Folgefunktionsplanung

Veröffentlichung der Apifox WEB-Version, um die Verwendung von Apifox auf der Browserseite zu unterstützen. Unterstützung für Schnittstellenleistungstests (ähnlich wie JMeter). Unterstützt den Plug-in-Markt und Sie können Plug-ins selbst entwickeln. Öffnen Sie die Apifox-API, damit Entwickler Apifox-Funktionen über die API aufrufen können. Unterstützt weitere Schnittstellenprotokolle wie GraphQL, gRPC, Websocket usw. Unterstützt die Offline-Nutzung. Projekte können online synchronisiert werden (für die Teamzusammenarbeit) oder nur lokal gespeichert werden (für die Offline-Nutzung auf einem einzelnen Computer).

4. Weitere Screenshots der Apifox-Funktion

Schnittstellen-Debugging

Benutzerdefinierte Mock-Regeln

Smart Mock

Schnittstellenautomatisierung

Projektimport

Projektexport

Mehrfach Themen zur Auswahl

5. Apifox-Download-Adresse

Die Einführung so vieler praktischer Funktionen von Apifox ist ein echter Vorteil! Die Software ist völlig kostenlos und kann als „Gewissen Chinas“ bezeichnet werden. Interessierte Freunde, die sie benötigen, können den untenstehenden Link direkt kopieren, in den Browser einfügen und zum Herunterladen öffnen oder darauf klicken, um den Originaltext direkt zu lesen! Offizielle Website-Adresse: https://www.apifox.cn/