Jetzt verwende ich PHP, um viele API-Schnittstellen zu schreiben. Bitte helfen Sie mir, ein solches System einzuführen
Antwortinhalt:
Das. . . . . Es ist nicht nur ein API-Problem. . . Das Kernsystem (Gesamtsystem) muss beim Entwurf der Architektur berücksichtigt werden. Wenn Sie es entwickeln und es nur der Außenwelt zugänglich machen, macht dieses Framework höchstens Sinn, da es nur Protokolle, Status usw. verwaltet. usw., und neue Schnittstellen müssen noch mit kombiniert werden. Das datenbereitgestellte System leistet sehr gekoppelte Arbeit.
Im Ausland ist Swagger (Swagger – The World's Most Popular Framework for APIs.), derzeit das beste in China ist EOAPI ( EOAPI – die branchenführende Schnittstellenverwaltungsplattform ).
EOAPI war schon immer relativ zurückhaltend im Vergleich zu anderen Gimmick-Produkten, es konzentriert sich mehr auf die Verbesserung der Benutzererfahrung und Funktionalität, daher bevorzuge ich es. EOAPI verfügt über eine Online-Version und eine Open-Source-Version, basierend auf PHP.
Im Anhang finden Sie eine Einführung in EOAPI (von der offiziellen Website von EOAPI):
Schnittstellenmanagement
Ob Sie ein einzelner Entwickler, ein Unternehmerteam oder ein reifes Unternehmen sind, eoapi erfüllt alle Ihre Anforderungen an das Schnittstellenmanagement.
Es ist nicht mehr notwendig, für jedes Projekt eine unabhängige Schnittstellenverwaltungsplattform aufzubauen und Offline-Schnittstellendokumente zu schreiben. Die gesamte Projektschnittstellenverwaltung wird in der Cloud durchgeführt.
Projektzusammenarbeit
Herkömmliche Dokumententools wie Word, Excel und selbst erstellte Wikis können umständliches Schreiben, schwieriges Lesen, und Wartungsprobleme und andere Mängel.
eoapi ermöglicht es Ihnen, nach der Registrierung mit der Zusammenarbeit zu beginnen. Dank standardisierter Dokumente, klarer Klassifizierungen und einer benutzerfreundlichen Leseoberfläche sind Dokumentaktualisierungen und Zusammenarbeit nicht mehr schmerzhaft.
Online-Tests
Herkömmliche Testtools wie DHC und Postman können die Schnittstellenverwaltungsarbeit nicht mehr erfüllen und können keine Leistungstestberichte bereitstellen.
eoapi ersetzt herkömmliche Testtools. Es ist nicht erforderlich, die Mauer zu umgehen und zu installieren. Sie können vollständige Schnittstellentestinformationen mit nur einem Klick auf der Webseite erhalten.
Persönliche Open-Source-Version von EOAPI (EOAPI – die branchenführende Schnittstellenverwaltungsplattform ): Was ist ShowDoc?
Immer wenn wir ein von anderen entwickeltes Modul oder Projekt übernehmen und uns den unkommentierten Code ansehen, werden wir alle verrückt. Wo sind die Dokumente? ! Wo sind die Dokumente? ! Zeig mir den Arzt! !
Alle Programmierer hoffen, dass andere technische Dokumente schreiben können, aber sie möchten selbst keine Dokumente schreiben. Da das Schreiben von Dokumenten viel Zeit mit der Formatierung und dem Nachdenken über verschiedene nichttechnische Details erfordert, beispielsweise in welches Verzeichnis das neue Word-Dokument abgelegt werden soll.
Word-Dokumente sind auf verschiedene Personen im Team verteilt. Leute, die Dokumente benötigen, schreien einfach, schreien und gehen dann zu QQ oder per E-Mail, um die von der anderen Partei gesendeten Dokumente zu erhalten. Diese Art der Kommunikation ist zwar möglich, aber nicht effizient.
ShowDoc ist ein Online-Tool zum Teilen von Dokumenten, das sich sehr gut für IT-Teams eignet. Es kann die Effizienz der Kommunikation zwischen Teams beschleunigen.
Wofür es verwendet werden kann
API-Dokumentation (siehe Demo)
Mit Mit Durch die Entwicklung des mobilen Internets wird BaaS (Backend as a Service) immer beliebter. Der Server stellt eine API bereit, und die APP-Seite oder das Web-Frontend können problemlos Daten aufrufen. Mit ShowDoc lassen sich sehr bequem und schnell schöne API-Dokumente schreiben.
Datenwörterbuch (Demo ansehen)
Ein gutes Datenwörterbuch kann anderen Ihre Datenbankstruktur leicht erklären, z. B. die Erklärung jedes Feldes usw.
Dokumentation
Sie können showdoc verwenden, um Anweisungen für einige Tools zu schreiben, und Sie können auch einige technische Spezifikationsdokumente schreiben, die das Team überprüfen kann .
Welche Funktionen hat es?
Teilen und exportieren
Responsives Webdesign, kann Teilen Sie Projektdokumente zur Ansicht auf Ihrem Computer oder Mobilgerät. Gleichzeitig können Sie das Projekt auch in eine Word-Datei exportieren, um es offline zu durchsuchen.
Berechtigungsverwaltung
Öffentliche Projekte und private Projekte
Die Projekte auf ShowDoc haben öffentliche Projekte und private Projekte. Auf öffentliche Projekte kann jeder angemeldete oder nicht angemeldete Benutzer zugreifen, während für private Projekte ein Passwort zur Authentifizierung des Zugriffs erforderlich ist. Das Passwort wird vom Projektersteller festgelegt.
Projektübertragung
Projekterstellern steht es frei, Projekte an andere Benutzer der Website zu übertragen.
Projektmitglieder
Sie können ganz einfach Projektmitglieder für ShowDoc-Projekte hinzufügen und löschen. Projektmitglieder können das Projekt bearbeiten, aber nicht übertragen oder löschen (nur der Projektersteller hat die Berechtigung)
Bearbeitungsfunktion
Markdown-Bearbeitung
ShowDoc verwendet den Markdown-Editor, der ein hervorragendes Bearbeitungs- und Leseerlebnis bietet. Wenn Sie Markdown nicht kennen, suchen Sie bitte in der Suchmaschine nach „Markdown verstehen und erste Schritte mit Markdown“. Klicken Sie auf der Bearbeitungsseite von ShowDoc auf die Schaltfläche über dem Editor, um ganz einfach API-Schnittstellenvorlagen und Datenwörterbuchvorlagen einzufügen. Nach dem Einfügen der Vorlage müssen nur noch die Daten geändert werden, was viel Bearbeitungsaufwand erspart.
Historische Version
ShowDoc bietet eine historische Versionsfunktion für die Seite, mit der Sie die Seite problemlos wiederherstellen können vorherige Version.
Bereitstellung auf Ihrem eigenen Server
ShowDoc-Bereitstellungshandbuch
Bitte beachten Sie:
http://
blog.star7th.com/2016/05/2007.html
Online ShowDoc verwendenWenn Sie keinen eigenen Server haben, aber ShowDoc als Dateifreigabetool verwenden möchten, dann sind Sie hier genau richtig kann Online ShowDoc ShowDoc
verwenden
Ja, Kong – Open-Source-API und Microservice-Verwaltungsschicht
Alibabas RAP
-Link: Willkommen bei der Verwendung von RAP
Offizielle Website-Einführung: RAP ist ein visuelles Schnittstellenverwaltungstool, das durch Analyse der Schnittstellenstruktur dynamisch Simulationsdaten generiert und die Richtigkeit der realen Schnittstelle überprüft , rund um die Schnittstellendefinition, verbessert die Effizienz unserer Zusammenarbeit durch eine Reihe automatisierter Tools. Unser Motto: Seien Sie effizienter und kommen Sie zum Abendessen nach Hause!
Github-Link: home_cn · thx/RAP Wiki · GitHub
Github-Einführung: Inhaltsverzeichnis generiert mit DocToc
Was ist RAP? Funktionen von RAP
RAP ist ein GUI-WEB-Schnittstellenverwaltungstool. In RAP können Sie die URL der Schnittstelle, das Format der Anforderungs- und Antwortdetails usw. definieren. Durch die Analyse dieser Daten stellt RAP Automatisierungstools wie MOCK-Dienste und Testdienste bereit. RAP bietet außerdem zahlreiche Funktionen auf Unternehmensebene, um Unternehmen und Teams bei der effizienten Arbeit zu unterstützen.
about_cn · thx/RAP Wiki · GitHubWas ist RAP?
Im Entwicklungsmodus, in dem Front- und Back-End getrennt sind, müssen wir normalerweise ein Schnittstellendokument definieren, um die spezifischen Informationen zu standardisieren der Schnittstelle. Zum Beispiel die Adresse einer Anfrage, wie viele Parameter es gibt, Parameternamen und Typbedeutungen usw. RAP erleichtert dem Team zunächst die Eingabe, Anzeige und Verwaltung dieser Schnittstellendokumente und verbessert durch die Analyse strukturierter Dokumentdaten, die Wiederverwendung und Generierung von Selbsttestdaten, die Bereitstellung von Selbsttestkonsolen usw. die Entwicklungseffizienz erheblich.
about_cn · thx/RAP Wiki · GitHubFunktionen von RAP
Leistungsstarke GUI-Tools und leistungsstarke Benutzererfahrung, Sie werden sich in die Verwendung von RAP zur Verwaltung Ihrer API-Dokumente verlieben.
Kompletter MOCK-Service Sobald das Dokument definiert ist, sind alle Schnittstellen bereit. Mit MockJS kann Ihr Geschäftsmodell, egal wie komplex es ist, gut zufrieden sein.
Riesige Benutzerbasis RAP wird von mehr als 200 Großprojekten in Alibaba und auch von vielen bekannten Unternehmen und Open-Source-Leuten verwendet. RAP ist mit dem Erfolg dieser Unternehmen gewachsen und konzentriert sich auf Details, das Erfassen von Qualität und das Bestehen von Tests.
Kostenloser professioneller technischer Support RAP ist kostenlos und Ihre technischen Anfragen werden innerhalb von 24 Stunden beantwortet. In den meisten Fällen erhalten Sie innerhalb einer Stunde eine Antwort.
Persönliche Erfahrung: 1. Sie können JSON direkt importieren 2. Nachdem das Dokument geschrieben wurde, können Sie MockJS direkt verwenden, um Testdaten zu generieren 3. Nachdem Sie den Feldnamen eingegeben haben, können Sie die ALT-Eingabetaste drücken und die Datenstruktur desselben Felds wird generiert. 4. Sie können die Schnittstelle direkt an einen anderen Ort kopieren oder verschieben 5 Sie können das Dokument auch direkt exportieren, es kann jedoch nur in HTML exportiert werden
WSO2-API-Verwaltung
CrapApi: Ein kostenloses und Open-Source-API-Schnittstellen- und Dokumentenverwaltungssystem (Anwendungsschnittstellenverwaltungssystem), erstellt von anjularjs Bootstrap SpringMVC CrapApi|Interface Management System
CrapApi|Api Interface Management System Systemfunktionen: einfach, extrem, Open Source, auf dem neuesten Stand Hauptfunktionen: Schnittstellenverwaltung, Schnittstellen-Debugging, Dokumentenverwaltung, Datenwörterbuchverwaltung....
Apizza – ein API-Management-Tool für Geekshttp://apizza.cc
Verwandte Interessen: Autor
http://www.easyapi.com EasyAPI-Serviceplattform, einschließlich API-Management, API-Tests und API-Überwachung. Ich bin der Gründer. Willkommen zur Kommunikation.
Es macht wenig Sinn, unter der ursprünglichen API-Situation ein API-Managementsystem aufzubauen. Tatsächlich wünschen sich Ingenieure einen vollständigen Satz von API-Entwicklungsframeworks. Das API-Framework integriert grundlegende Benutzersysteme, wie z. B. die Open-Source-Lösung ucenter. Integrieren Sie Testassistenten und unterstützen Sie Fehlerbeschreibungen in mehreren Ländern. Erhalten Sie Anforderungs-Caching, Restful Design und Integration mit Gitlab für die Versionsverwaltung. Anschließend wird Jenkins verwendet, um Pull-Versions-Unit-Tests, Smoke-Tests, Stresstests und die Ausführung von Protokollanalysen zu automatisieren , Extrahieren von Fehler-Crash-Protokollen und E-Mail-Benachrichtigungen. Der High-End-Punkt kann spezifisch für die Speichernutzungskurve zwischen verschiedenen Versionen einer bestimmten API und für die Anforderungszeitkurve bei derselben Parallelität sein.Wenn das Produktions-API-System ausgeführt wird, können Statistiken erzielt werden, die der spezifischen API-Ebene entsprechen, einschließlich aller Header-Informationen. Wenn kein normales Rückgabeergebnis vorliegt, führt die API eine Fehlerprotokollierung durch und organisiert sie im Protokollsystem und sendet E-Mails an die Mailbox des Programmierers sowie Zugriffs- und Netzwerkregeln. Sie können verschiedene Arten von Anfragen innerhalb einer Zeiteinheit begrenzen, z. B. die Beschränkung bestimmter IPs oder IP-Bereiche auf eine bestimmte API-Patch-Anfrage und die Gesamtzahl der Anfragen innerhalb einer Stunde ist 5.000. Die API unterstützt mehrere Arten von Anforderungen, z. B. Get Post Patch, Put, Delete Head, unterstützt mehrere zurückzugebende Datentypen, z. B. das komprimierte XML-JSON-JSONP-MSGPACK-Format, und stellt SDKs in mehreren Programmiersprachen bereit. Mein Team führt beispielsweise mobile Entwicklung durch und ich Bereitstellung einer Java Objective-C-Version der gekapselten Klassenbibliothek, ein Drittteam beschäftigt sich mit Golang und kapselt eine Golang-Version von SDK. Das API-System unterstützt die Echtzeitproduktion von Dokumenten in verschiedenen Versionen des PDF-Epub-Formats, SDK und SDK-Dokumente den Kunden ausgehändigt werden, anstatt das Online-Set für die Kunden zu öffnen. Mit Ausnahme des kontinuierlichen Integrationssatzes handelt es sich bei den übrigen oben genannten um API-Systemarbeiten. Ich werde Bilder veröffentlichen, wenn ich Zeit habe.
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn