Kostenloses Open-Source-API-Managementsystem

Projektadresse: https://github.com/sharemen/api-admin

Dieses Projekt ist die ursprüngliche Projektadresse der Sekundärentwicklung basierend auf XXL-API v1.1.1: https://github.com/xuxueli/xxl-api

Zur ursprünglichen Funktion hinzugefügt:

1. Die Schnittstellen-Stammadresse der unabhängigen DEV-Umgebung
2. Das Gastkonto wird standardmäßig hinzugefügt, um den Gastmoduszugriff zu unterstützen (es können nur Schnittstellentests ausgeführt und Scheindaten hinzugefügt werden), das für das Geschäfts- und Kundendienstpersonal verwendet wird
3. Fügen Sie Hinweise zu API-Anforderungsparametern, Hinweisen zu Antwortergebnisparametern und abhängigen Ressourceneigenschaften hinzu
4. Fügen Sie den Datensatz des API-Änderungsverlaufs hinzu, der den Ersteller und die Person der letzten Änderung anzeigt
5. Wenn Sie eine Schein-URL-Anpassung hinzufügen, können Sie über /mock/run/{API URL} direkt auf die Standard-Mock-Daten der entsprechenden API zugreifen (kann angegeben werden), was für das Front-End-Team praktisch ist, um eine einheitliche Konfiguration von Scheintests durchzuführen
6. Zugriffsunterstützung für das Apollo-Konfigurationscenter hinzufügen (Konfiguration ist optional)
7. Fügen Sie Unterstützung für Atlassian Confluence hinzu, um Wiki-Dokumente automatisch über die API zu generieren, und passen Sie das generierte Format an, indem Sie resources/templates/wiki/api.wikitemplate.ftl ändern (Konfiguration ist optional).

Funktionsanweisungen

• Das System zum Erstellen einer Branchen-
  API ist: Branche/Projekt/Gruppe/Schnittstelle

• Projekt erstellen

Die Stammadresse ist der Host der API, der in Online, Vorabversion, Test und Entwicklung unterteilt ist und je nach Situation ausgefüllt werden kann

Später wird beim Testen der Schnittstelle tatsächlich der {host} + {apiurl} der entsprechenden Umgebung zum Initiieren der Anforderung verwendet

Klicken Sie hier, um das Projekt aufzurufen und die Schnittstelle des Projekts zu verwalten

• Gruppe erstellen

Die Schnittstelle unterstützt die Gruppierung. Wenn nicht ausgewählt, wird die Standardgruppierung verwendet. Es wird empfohlen, die Schnittstelle nach dem „Geschäftsfeld“ für die Schnittstellenpflege und -verwaltung zu unterteilen

• Schnittstelle erstellen

• Grundlegende Informationen zur Schnittstelle

Wenn die automatische Wiki-Synchronisierung aktiviert ist, ist org.s.apiadmin.enableSyncWiki = 1

Akzeptieren Sie die angegebene übergeordnete Wiki-Adresse (das Schnittstellen-Wiki wird automatisch als Unterseite dieser URL veröffentlicht) oder die Wiki-Adresse, die der aktuellen API entspricht (das Schnittstellen-Wiki aktualisiert automatisch die der Adresse entsprechende Seite).

Die der angegebenen API entsprechende Wiki-Adresse wird vorrangig vor der übergeordneten Wiki-Adresse verwendet.

Wenn nichts ausgefüllt ist, wird die Wiki-Seite automatisch im Stammverzeichnis des Standard-Wiki-Bereichs veröffentlicht, der dem Wert des Konfigurationselements {org.s.apiadmin.wikidefaultspace} entspricht

Beachten Sie außerdem, dass der durch org.s.apiadmin.wikiuser konfigurierte Wiki-Benutzer über die Berechtigung zum Betrieb des angegebenen Wiki-Bereichs (add\modify\query) verfügt.

• Schnittstellentest

、

Nachdem Sie die Schnittstelle hinzugefügt haben, können Sie über die Schaltfläche auf der Seite „Schnittstellendetails“ auf die Schnittstellentestschnittstelle zugreifen.

Hier sind insbesondere 2 Punkte:

1. Wenn die aktuelle Schnittstelle Parameter über den Anforderungsparameter akzeptiert, sollte die Option zur standardmäßigen Verwendung des Anforderungstexts deaktiviert werden. Wenn es sich um den direkten körperlastigen JSON-Inhalt handelt, sollte dies überprüft werden
2. Die interne Schnittstelle des Unternehmens verfügt im Allgemeinen über eine Authentifizierung, daher besteht die Möglichkeit, das Testtoken automatisch abzurufen. Wenn Sie es aktivieren, bedeutet dies, dass diese Anforderung eine Authentifizierung durchführen muss. In XxlApiTestController

run(XxlApiTestHistory, HttpServletRequest, HttpServletResponse)

Die Anmeldemethode bei der Zugriffsschnittstelle ist reserviert und dieser Teil der Logik muss selbst implementiert werden

/**
	 * 实现网关登录调用  公司自己有接口网关需要登录时使用
	 * @param remoteRequest
	 * @param request
	 * @return
	 */
	private String remoteCallWtihLogin(HttpRequestBase remoteRequest,HttpServletRequest request,Map<String, Object> queryParamMap) {
		String responseContent = null;
		
		//TODO 实现接口网关登录逻辑
			
		responseContent = remoteCall( remoteRequest );
			
			
		
		
		return responseContent;
	}
	

• Schein hinzufügen

Fügen Sie auch Scheindaten über die Schaltfläche „Schnittstellendetailseite“ hinzu.

Die ersten erstellten Mock-Daten werden als Standard-Mock-Daten der Schnittstelle verwendet, auf die direkt über  http://{apiadmin-host}/api-admin/mock/run/{ apiurl} zugegriffen werden kann.

apiadmin-host ist der Zugriffshost des aktuellen Schnittstellenverwaltungssystems

Auf diese Weise ist es für den Front-End-Code praktisch, während des Debuggens und der einheitlichen dynamischen Konfiguration die Scheindaten der entsprechenden Schnittstelle abzurufen.

Wenn mehrere Scheindaten vorhanden sind, können Sie den Standardwert der Schnittstellen-Mockdaten festlegen, indem Sie auf den Link „Als Standard festlegen“ klicken, der den Scheindaten entspricht

Um auf bestimmte Scheinstatusdaten zuzugreifen, müssen Sie nur auf die URL zugreifen, die durch Klicken auf „Ausführen“ geöffnet wird.