IDEA-Plugin ist neu! So schnell ist Schnittstellendokumentation erstellt!

Wenn Schnittstellen-Docking erforderlich ist, muss sich die Entwicklung endlich nicht mehr um die Schwierigkeit kümmern, API-Dokumente zu schreiben, und es besteht keine Notwendigkeit, Schnittstellendokumente einzeln neu zu schreiben! Installieren Sie dieses IDEA-Plug-in, um Dokumente in einem Schritt in Postcat zu importieren.

Was wurde aktualisiert?

Dieses Plug-in ist einfach zu bedienen und zu verwenden, sodass Entwickler die Arbeit zum Schreiben von API- Dokumenten sparen und sich mehr auf die Entwicklung konzentrieren können. Das Plug-in analysiert Benutzerkommentare für die Schnittstellenanalyse und generiert schließlich Schnittstellendokumente und lädt sie auf den Postcat-Server hoch, sodass Entwickler APIs auf Postcat verwalten und teilen können, wodurch die Zusammenarbeitsfähigkeit und die Entwicklungsgeschwindigkeit verbessert werden.

Was ist der Unterschied zu Swagger?

Das Postcat-Plug-in dringt nicht in den Code ein, und es ist nicht erforderlich, Abhängigkeiten von JAR-Paketen hinzuzufügen

Das Plug-in analysiert Benutzerkommentare für die Schnittstellenanalyse und generiert schließlich Schnittstellendokumente und lädt sie auf den Postcat-Server hoch, sodass Entwickler APIs auf Postcat verwalten und teilen können, wodurch die Zusammenarbeitsfähigkeit und die Entwicklungsgeschwindigkeit verbessert werden.

Postcat bietet eine Vielzahl von erweiterten Anmerkungen wie @path , @url , @method , und , die angepasst oder mit vorhandenen Anmerkungen in der Einstellungsschnittstelle kompatibel sein können @name . @hidden @required

Darüber hinaus bietet Postcat auch eine Funktion zum Generieren von Kommentaren.Bei Klassen und Methoden ohne oder mit nur wenigen Kommentaren müssen Entwickler diese nicht manuell hinzufügen.Diese Funktion kann die Bedeutung von Methodenfeldern analysieren und automatisch Kommentare generieren. Entwickler müssen nur die tatsächlichen Szenarien überprüfen oder optimieren, um ein relativ vollständiges API-Dokument zu erstellen.

Wenn die ursprünglichen Anmerkungen nicht ausreichen, fügt Postcat zusätzliche Anmerkungen hinzu Beim Entfernen von Anmerkungen werden nur die von Postcat bereitgestellten erweiterten Anmerkungen entfernt, und die eigenen Anmerkungen des Benutzers werden nicht zerstört. Gleichzeitig können Entwickler mit der „Intent“-Funktion auch Plug-in-Kommentare lokal generieren sowie Anpassungen und Modifikationen vornehmen.

Postcat bietet eine Vielzahl von API- Upload-Methoden, die Entwickler bequem in verschiedenen Szenarien verwenden können:

Bei bestehenden Projekten, die Postcat zum ersten Mal verwenden, können Entwickler Tools die Gruppe Upload Project Api Doc um den Schnittstellen-Upload auf Projektebene abzuschließen.
Für den unter neuen Anforderungen erstellten Controller kann der Entwickler nach Abschluss der Schnittstellendefinition mit der rechten Maustaste auf das Menü klicken und auswählen, Upload All Api dass alle Dateien auf einer einzigen Dateiebene hochgeladen werden, sodass Dokumente vor Logik und Front-End und Back- Arbeitsende wird nicht mehr seriell gesperrt.
Für die Änderung einiger einzelner Schnittstellen ist es nicht erforderlich, alle hochzuladen. Entwickler können mit der rechten Maustaste auf das Menü klicken und Upload Api Funktion Diese Funktion zeigt die Schnittstelleninformationen der aktuellen Bearbeitungsklasse an und bietet eine Schnittstellenvorschau und eine Schnittstellenauswahlschnittstelle , damit Benutzer die Notwendigkeit einer Aktualisierung überprüfen können oder Die hochgeladene Ziel-API führt eine Informationsprüfung und einen Upload durch.

Wie installiere und konfiguriere ich?

Die IDEA-Version muss größer als IntelliJ IDEA 2022.03 sein

Suchen Sie in IDEA „Einstellungen-Plug-In-Marketplace“ Postcat und finden Sie Postcat die Plug- In-Installation. Gleichzeitig kann es auch im IDEA-Plug-in-Markt heruntergeladen und installiert werden.Wenn das lokale IDEA nicht automatisch aktiviert wird, können Sie das ZIP-Paket direkt in IDEA ziehen, um die Installation/Aktualisierung abzuschließen.

Füllen Sie die Konfigurationsinformationen aus

Die Konfigurationsinformationen müssen für den ersten Upload ausgefüllt werden, und die Konfigurationsinformationen sind unabhängig.

Möglichkeiten zum Abrufen von Konfigurationsinformationen: Melden Sie sich bei Postcat an und geben Sie das Projekt ein, um Token, WorkspaceID und ProjectID zu erhalten.

Server ist standardmäßig ausgefüllt: https://postcat.com/api, Benutzer müssen nichts ändern
Token-Erwerb
3. WorkspaceID und ProjectID abrufen

Rufen Sie die Seite mit den Projekteinstellungen auf und klicken Sie auf das „Fragezeichen“ rechts neben dem Projektnamen

4. StringType bestimmt den Stringtyp der Ein- und Ausgangsparameter Nur wenn der Parametername der Buckelspezifikation am Anfang entspricht, wird die Änderung gefunden Das Vorschaufenster kann das Ergebnis der Änderung sehen

1. Wenn der Parameter benannt ist , wählen Sie camelCase aus, dies ist userInfo immer noch die Standardoption userInfo

2. Wenn der Parametername userInfo , wählen Sie Lower_Underscore, es wird user_info

3. Wenn der Parametername userInfo , wählen Sie UPPER_UNDERSCORE, es wird USER_INFO

Vorsichtsmaßnahmen

Stellen Sie vor dem Parsen und Hochladen sicher, dass IDEA im Projekt erstellt wurde und die zugehörigen Abhängigkeiten heruntergeladen wurden.
Es wird dringend empfohlen, die vom Plug-in definierten Kommentare zu verwenden. Das Plug-in verfügt über eine leistungsstarke Funktion zum Generieren von Kommentaren. Es wird dringend empfohlen, die Kommentare des Plug-ins vor dem Bearbeiten und Hochladen zu generieren. Die Kommentare können auch in den Einstellungen angepasst.
Wenn die Plug-in-Annotationen nicht erkannt werden, werden die Annotationen Spring MVC , , und Swagger.v2 nur teilweise unterstützt. Swagger(OpenAPI).v3 Um zu vermeiden, dass erforderliche Parameter fehlen, wird empfohlen, Plugin-Anmerkungen zu verwenden.
Die Funktion zum Generieren von Anmerkungen bietet nur eine einfache Unterstützung für Anmerkungen von Spring MVC , und Swagger.v2 , ohne dass Sie sie umschreiben können. Swagger(OpenAPI).v3
HTTP Die Schnittstelle beurteilt nur durch Routing- und Anforderungsverfahren, um eine Überlagerungsaktualisierungsverarbeitung durchzuführen
Für die hochgeladene API wurde sie manuell im Web geändert. Es wird nicht empfohlen, die Upload-Funktion zu verwenden, da der Plug-in-Upload den vorherigen Inhalt überschreibt.
Nach dem Generieren/Eingeben des Plug-ins Javadoc wurden die Schnittstellen-URI, die Anforderungsmethode (GET/POST) usw. geändert, und das Plug-in Javadoc muss manuell geändert werden, andernfalls erkennt das Plug-in die alte Plug-in-Javadoc-Informationen.
Die automatisch generierten Klassenanmerkungen werden standardmäßig hochgeladen 默认分组 , bitte füllen Sie die tatsächliche Gruppe selbst aus, und die Gruppe wird namentlich identifiziert.
1. . Trennen Sie Gruppen mit mehreren Ebenen mit .Wenn Sie beispielsweise die Schnittstelle in die Gruppe 第三方 unter der Gruppe übertragen müssen, füllen Sie für Gruppenname den Third-Party.Benutzer ein. 用户
@group-name Kommentare werden auf Methodenebene unterstützt und nicht standardmäßig generiert. Sie können sie manuell zu Methodenkommentaren hinzufügen, und das Plug-in hilft Ihnen dabei, die aktuelle Methode in der entsprechenden Gruppe zu speichern.
Informationen zum Scannen und Hochladen von APIs auf Projektebene [Tools -> Upload Project Api Doc] finden Sie im oberen Menü für spezifische Nutzungsregeln 项目级上传 .
Generierte @required Klassenannotationen und werden nur javax.validation.constraints.NotNull für Felder mit Annotationen generiert.
Es wird nicht empfohlen, @remark Annotationen , das Plugin behält die Erkennungsfunktion bei und fügt den Inhalt in die Feldbeschreibung ein, und die generierten Klassenannotationen werden nicht automatisch generiert.
Standardmäßig @PathVariable erkennt die POST-Methode den Parameter standardmäßig als Formdata-Typ und die GET-Methode erkennt den Parameter standardmäßig als Abfragetyp.
// Der markierte Kommentar kann nicht erkannt werden, bitte verwenden Sie /** */ die Markierung .

Erfahren Sie mehr über Postcat:

Postcat ist ein leistungsstarkes, plattformübergreifendes (Windows, Mac, Linux, Browser...) API-Entwicklungs- und Testtool auf Open-Source-Basis, das REST, Websocket und andere Protokolle (bald GraphQL, gRPC, TCP, UDP) unterstützt und Ihnen hilft Beschleunigen Sie den Abschluss der API-Entwicklungs- und Testarbeiten.

Postcat-Kernfunktionen:

API- Dokumentenverwaltung: API-Design visualisieren und API-Dokumente generieren
API- Testing: automatische Generierung von Testparametern, automatische Generierung von Testfällen, visuelle Datenbearbeitung
Plug-in-Erweiterung: Viele Plug-ins erweitern Produktfunktionen und schaffen eine API-Entwicklungsplattform, die Ihnen und Ihrem Team gehört
Mock: Generieren Sie Mock automatisch anhand von Dokumenten oder erstellen Sie benutzerdefinierte Mocks, um komplexe Szenarien zu erfüllen
Zusammenarbeit im Team: Es kann nicht nur die gemeinsame Nutzung von APIs realisieren, sondern auch Cloud-Speicherplatz für die Zusammenarbeit schaffen

Vorteile von Postcat:

Testen ohne Login: Sparen Sie sich das mühsame Verifizieren des Logins
Einfache Schnittstelle: keine redundanten Funktionen und komplizierten Optionen
Kostenlos: kleine und mittlere Teams und private Nutzung
Umfangreiche Plug-Ins: Unterstützung von bis zu 22 Plug-Ins für Datenmigration, Themen, API-Sicherheit usw.
Inland: Kann die Bedürfnisse von Heimanwendern besser verstehen und ohne Barrieren mit dem Entwicklungsteam kommunizieren
Perfekte Benutzerdokumentation: Folgen Sie der Bedienung, um schnell loszulegen

Mehr Ausgaben! Mehr Feedback!

Wenn Sie während der Nutzung Fragen haben, können Sie ein Problem online einreichen (diese Open-Source-Methode wird dringend empfohlen), und die Frage selbst trägt bereits zur Community bei:

https://github.com/Postcatlab/postcat/issues

Wenn es Ihnen gefällt, können Sie es genauso gut mit Star unterstützen

Dieses Projekt ist Open Source, wenn Sie denken, dass dieses Projekt nicht schlecht ist, können Sie genauso gut auf einen Stern klicken, um es zu unterstützen!

Github:

https://github.com/Postcatlab/postcat

Gitee:

https://gitee.com/eolink_admin/postcat