Viele Freunde beherrschten ihr Geschäft bereits sehr gut, als sie zum ersten Mal Produktmanager wurden, aber sie hörten immer noch unweigerlich Beschwerden von Entwicklern: „Warum stehen so viele Anforderungen aneinander und so viele Schnittstellen können nicht fertiggestellt werden?“ Der Manager sagte nur: Können Sie es mit einem verwirrten Blick ausdrücken: Schnittstelle? Was es ist? Habe ich meine Seitenfunktionen nicht schon ausführlich im Dokument niedergeschrieben?
Tatsächlich sind auf Systemebene neben sichtbaren Inhalten wie Texten und Schaltflächen auch viele logische Ketten unter den Inhalten verborgen – Schnittstellen, die wir oft als APIs bezeichnen . Dieser Artikel hilft Ihnen dabei, APIs basierend auf den Grundkenntnissen von APIs und den spezifischen Geschäftsszenarien von Produktmanagern besser zu verstehen und zu verwenden, sodass Sie effizienter mit Entwicklern zusammenarbeiten können.
Was ist API?
API oder Application Program Interface ist eine Reihe definierter Regeln, die es verschiedenen Anwendungen ermöglichen, miteinander zu kommunizieren. Es fungiert als mittlere Schicht, die den Datentransfer zwischen Systemen abwickelt und es Unternehmen ermöglicht, ihre Anwendungsdaten und -funktionen für externe Drittentwickler, Geschäftspartner und interne Unternehmensabteilungen zu öffnen.
Bildquelle: CSDN@tbprice
Die Funktionsweise der API ist eigentlich leicht zu verstehen. Wir können die Funktionsweise der API leicht verstehen, indem wir sie über die WeChat-Zahlung erklären. Wenn wir etwas zum Mitnehmen bestellen, werden wir vom System aufgefordert, „WeChat-Zahlung“ oder andere Zahlungsmethoden von Drittanbietern zu verwenden. Die Ausführung dieser Zahlungsfunktion ist auf die API angewiesen. Wenn wir auf die Zahlungsschaltfläche klicken, wird ein API-Aufruf durchgeführt, um die Informationen abzurufen (auch Anfrage genannt). Die Anfrage wird von der Anwendung an den Webserver über den Uniform Resource Identifier (URI) der API verarbeitet, der das Anfrageverb, Header und manchmal den Anfragetext enthält.
Nach Erhalt einer gültigen Anfrage von der Produktwebseite ruft die API ein externes Programm oder einen Webserver auf, also ein Zahlungssystem eines Drittanbieters. Der Server sendet eine Antwort an die API, die die angeforderten Informationen enthält. Die API überträgt Daten an die ursprünglich anfragende Anwendung, in diesem Fall die Produktwebsite. Obwohl die Datenübertragung je nach verwendetem Webdienst unterschiedlich ist, erfolgen Anfragen und Antworten alle über die API. Diese Übertragungen sind für die Benutzeroberfläche nicht sichtbar, was bedeutet, dass die API Daten innerhalb des Computers oder der Anwendung austauscht und für den Benutzer wie eine seidenweiche, nahtlose Verbindung erscheint.
Wie werden APIs klassifiziert?
Da sich die Kommunikationsszenarien ändern, werden auch die Klassifizierungsdimensionen von APIs unterschiedlich sein:
- Aufgeteilt nach API-Anbietern: eigene API, Drittanbieter-API (zum Beispiel: Identitätsauthentifizierung , SMS-Dienst , Zahlungsdienst , großes KI-Modell usw.).
- Unterteilt nach technischen API-Attributen: System-API (zum Beispiel: Caching, Timing, Benachrichtigung, Überwachung usw.), Geschäfts-API (Mitgliedschafts-API, Produkt-API, Inhalts-API, Transaktions-API usw.), Plattform-API (individuelle Anmelde-API). , Such-API, AI-Kundendienst-API usw.).
- Unterteilt nach API-Aufrufmethoden: synchrone API, asynchrone API.
- Unterteilt nach API-Granularität: Service-APIs (zum Beispiel: Meituan Takeaway API , Taobao Mall API, JD Express API usw.), funktionale APIs (zum Beispiel: Kurzketten-API , Standort-API , Unternehmensauthentifizierungs-API usw.).
- Unterteilt danach, ob die API für die Außenwelt offen ist: interne API, offene API.
In welchen Szenarien müssen Produktmanager APIs entwerfen?
- Bei der Entwicklung internetbasierter Anwendungen (SPA-Anwendungen, APP-Anwendungen, kleine Programme, Smart-Device-Anwendungen usw.) ist die technische Architektur im Wesentlichen ein Client-Server-Modell. Zu diesem Zeitpunkt ist der Server im Wesentlichen eine API und der Produktmanager Es muss nur das Unternehmen beschrieben werden.
- Bei der Bereitstellung technischer Schnittstellen für vor- und nachgelagerte Benutzer werden diese grundsätzlich in Form von APIs bereitgestellt. Zu diesem Zeitpunkt müssen Produktmanager APIs entwerfen und definieren.
- Wenn Unternehmensdienste monetarisiert und als APIs bereitgestellt werden, müssen Produktmanager APIs entwerfen, APIs definieren, APIs bepreisen usw.
In welchen Szenarien nutzen Produktmanager APIs von Drittanbietern?
Aufgrund von Kostenfaktoren, Faktoren des Daten- oder Ressourcenbestands, Faktoren der technischen Leistungsfähigkeit usw. ist es bei der Entwicklung digitaler Systeme durch Unternehmen unmöglich, alle Dienste selbst zu entwickeln, noch werden sie unter Verwendung von Open-Source-Code in großem Umfang erstellt APIs anderer Anbieter sind zu einer unvermeidlichen Wahl geworden.
Gängige Grundszenarien wie die Anmeldung: Beim Entwerfen einer Anwendung ist die Anmeldefunktion des Benutzers die grundlegendste Funktion. Benutzer müssen nicht in jeder Software ein separates Konto registrieren, sondern können sich mit WeChat, QQ, Alipay und anderen Konten anmelden das Programm. Ähnliche Szenarien umfassen KYC-Authentifizierung , Single Sign-On, Sicherheitsmanagement, Geldeinzug und -zahlung, Social Sharing, Benutzerkommunikation usw.
Szenarien, die Plattformressourcen wie Reisereservierungen nutzen : Die Grundfunktion der großen Reiseplattformsoftware besteht darin, Flug- und Hotelinformationen zu aggregieren und unterschiedliche Preise zu unterschiedlichen Terminen anzuzeigen. Normalerweise stammen diese Daten von Tausenden von Websites und Homepages, und dieser Service wird auch über eine API bereitgestellt. Ähnliche Szenarien umfassen Expresszustellung und -logistik , Plattformen zum Mitnehmen, mehrere große E-Commerce-Plattformen usw. Unternehmen müssen APIs von Drittanbietern verwenden.
Szenarien, die technische Fähigkeiten von Drittanbietern nutzen, wie z. B. große KI-Modelle : Große KI-Modelle sind seit 24 Jahren ein neuer Favorit. Die meisten Unternehmen können sie nicht selbst entwickeln und werden sie hauptsächlich verwenden. Ähnliche Szenarien umfassen auch Cloud-Computing-Technologie, Blockchain-Technologie , Big-Data-Technologie, Speichertechnologie usw.
Verwenden Sie SaaS-Unternehmensanwendungen wie CRM : Plattformen wie CRM (Customer-Relationship-Management-Tools) umfassen oft viele integrierte APIs, die es Unternehmen ermöglichen, sich in die Anwendungen zu integrieren, die sie bereits verwenden, wie Messaging, soziale Medien und E-Mail-Anwendungen. Dadurch wird der Zeitaufwand für den Wechsel zwischen verschiedenen Anwendungen zur Durchführung von Vertriebs- und Marketingaufgaben erheblich reduziert. Ähnliche Szenarien umfassen Finanz-SaaS, Human-SaaS, Büro-SaaS, Marketing-SaaS usw.
Wie schreibt ein Produktmanager eine gute API-Produktdokumentation?
Die Hauptleser von Produkt-PRD sind Back-End-Entwicklung (RD), Front-End-Entwicklung (FE), Interaktionsdesigner (UI, UE) und Tests (QA). Sie erhalten die Arbeitsziele, die sie im PRD erreichen müssen , und verwenden Sie sie, um den Grundplan zu entwerfen.
Im vorherigen Artikel haben wir API-Kenntnisse erlernt und hatten eine Sprache, um mit Entwicklern zu kommunizieren. Jetzt müssen wir dieses Wissen in eine Beschreibung unserer Bedürfnisse umwandeln, damit Entwickler unsere Bedürfnisse verstehen können.
Das Folgende ist ein konkreter Fall: Angenommen, wir sind Produktmanager einer E-Commerce-Plattform und müssen nun eine neue API entwerfen, um die Funktion zum Erstellen von Benutzerbestellungen zu implementieren. Beim Schreiben der API-Produktdokumentation müssen wir die folgenden Aspekte berücksichtigen.
- Beschreibung der Schnittstellenfunktion : Zunächst müssen wir klären, welche Funktion diese API hat, nämlich die Erstellung von Benutzeraufträgen. Beschreiben Sie die Funktion im Dokument detailliert, einschließlich Eingabeparameter, Ausgabeergebnisse usw.
- Parameterbeschreibung : Für die Auftragserstellungsfunktion können Parameter wie Benutzerinformationen, Produktinformationen, Zahlungsinformationen usw. beteiligt sein. Listen Sie alle möglichen Parameter im Dokument auf und erläutern Sie deren Bedeutung, Typ und ob jeder Parameter erforderlich ist.
- Anforderungsbeispiele : Stellen Sie mehrere spezifische Anforderungsbeispiele bereit, um zu zeigen, wie Entwickler die API aufrufen, um die Funktion zur Auftragserstellung zu implementieren. Beispiele sollten Parameterkombinationen in verschiedenen Situationen abdecken, um ein klares Verständnis für Entwickler sicherzustellen.
- Rückgabeergebnis : Beschreibt, welche Art von Rückgabeergebnis nach dem Aufruf der API erhalten wird, einschließlich Erfolg und Fehler. Im Erfolgsfall sollten die zurückgegebenen Bestellinformationen detailliert sein; im Falle eines Misserfolgs sollte der Grund für das Scheitern erläutert werden.
- Fehlercodedefinition : Definieren Sie mögliche Fehlercodes und ihre Bedeutung, damit Entwickler beim Aufrufen von APIs Probleme anhand der Fehlercodes schnell lokalisieren können.
- Sicherheitsüberlegungen : Bei APIs, die vertrauliche Informationen wie Benutzerdaten oder Zahlungen betreffen, muss die Sicherheit berücksichtigt werden. Erläutern Sie im Dokument, wie die Sicherheit der Benutzerinformationen gewährleistet werden kann, z. B. durch die Verwendung des HTTPS-Protokolls, der Parameterverschlüsselung usw.
Mithilfe der obigen detaillierten Beschreibung können Produktmanager eine klare und vollständige API-Produktdokumentation verfassen, Anforderungen effektiv an Entwickler kommunizieren und sicherstellen, dass sie die erforderlichen Funktionen korrekt implementieren können.
Wie kommuniziere ich mit dem Entwicklungsteam über API?
Einheitliche Standards
Kommunikation ist ein Muss für das Projekt. Bevor Produktmanager mit Entwicklungspartnern in Kontakt treten, sollten sie auf die Vereinheitlichung von Standards und Methoden achten, um eine bessere Änderung und Nachverfolgung zu ermöglichen.
einheitliche Plattform
Mithilfe moderner Plattformen wie der iPaaS-Plattform und des API-Gateways stellen Unternehmen zunächst eine Implementierungskonsistenz auf der zugrunde liegenden technischen Ebene her, nutzen die Plattformfunktionen, ignorieren technische Komplexität und konzentrieren sich auf das Geschäft selbst.
einheitliches Werkzeug
Wenn technisches Personal API-Design durchführt, kann es API-Design-Tools verwenden, um Produktmanagern, Entwicklern und Testern die Kommunikation, Programmierung, Aktualisierung und Wartung auf einer gemeinsamen Sicht zu ermöglichen.
Die Raubkopien von „Qing Yu Nian 2“ wurden auf npmror hochgeladen, was dazu führte, dass npmmirror den Unpkg-Dienst einstellen musste: Es bleibt nicht mehr viel Zeit für Google. Ich schlage vor, dass alle Produkte Open Source sind . time.sleep(6) spielt hier eine Rolle. Linus ist am aktivsten beim „Hundefutter fressen“! Das neue iPad Pro verwendet 12 GB Speicherchips, behauptet jedoch, über 8 GB Speicher zu verfügen. People’s Daily Online bewertet die Aufladung im Matroschka-Stil: Nur durch aktives Lösen des „Sets“ können wir eine Zukunft haben Neues Entwicklungsparadigma für Vue3, ohne die Notwendigkeit von „ref/reactive“ und ohne die Notwendigkeit von „ref.value“. MySQL 8.4 LTS Chinesisches Handbuch veröffentlicht: Hilft Ihnen, den neuen Bereich der Datenbankverwaltung zu meistern Tongyi Qianwen GPT-4-Level-Hauptmodellpreis reduziert um 97 %, 1 Yuan und 2 Millionen Token