Introduktion id1761C0007W7
Adobe Experience Manager Guides (senare kallat AEM Guides) är en totallösning för företag som gör det möjligt för Adobe Experience Manager (AEM) att ha CCMS-funktioner (Component Content Management Solution) för att skapa och leverera DITA-baserat innehåll. Kunderna får tillgång till AEM Guides-arbetsflöden via programmeringsgränssnitt i AEM Guides för att integrera dem med andra företagsapplikationer. Dessa API:er kan också användas av Adobe partners för att förbättra AEM Guides värdeförslag genom att utöka dess funktionalitet eller genom att integrera den med andra program eller tjänster.
AEM Guides API:er
AEM Guides API:er finns i två format: HTTP och Java. Dessa API:er visar AEM Guides nyckelfunktioner för programutvecklare. Med de här funktionerna kan utvecklare skapa egna plugin-program för att utöka färdiga arbetsflöden. API:erna är tillgängliga när det gäller att hantera utdata för DITA-innehåll, arbeta med DITA-kartor, lägga till villkorsattribut i mappnivåprofiler och konvertera HTML- och Word-dokument till DITA-format.
Installera JAR på din lokala Apache Maven-databas install-jar-local
För att kunna använda JAR-filer som exponeras av AEM Guides måste du installera dem i din lokala Apache Maven-databas. Så här installerar du JAR:er på din plats i Maven-databasen:
-
Extrahera innehållet i AEM Guides-paketfilen (.zip) på din dator.
-
I kommandotolken navigerar du till följande mapp i sökvägen för det extraherade innehållet:
code language-none \jcr_root\libs\fmdita\osgi-bundles\install
-
Kör följande kommando för att installera API-paketet i din lokala Maven-databas:
code language-none mvn install:install-file -Dfile=api-X.x.jar -DgroupId=com.adobe.fmdita -DartifactId=api -Dversion=X.x -Dpackaging=jar**
note note NOTE I ovanstående kommando ska X.x ersättas med det faktiska versionsnumret i parametrarna Dfile och Dversion. -
(Valfritt) Installera beroendet i det lokala Maven-projektets databas. Du kan uppnå detta genom att skapa en mapp i Maven-projektet och sedan köra det
mvn install
-kommando som gavs i föregående steg med följande extra parameter:code language-none -DlocalRepositoryPath=<path_to_project_repository>
Om du sedan vill visa projektets lokala databasmapp för byggprocessen i Maven lägger du till ett
repository
-element i den överordnade pom.xml-filen enligt nedan:code language-xml <repositories> <repository> <id>project-repository</id> <url>file://${project.basedir}/repository</url> </repository> </repositories>
Den här processen installerar API-JAR:er i den lokala Maven-databasen.
Använda JAR-tjänstens API i ett Maven-projekt
När du har installerat API-JAR i din lokala Maven-databas utför du följande steg för att använda JAR i dina projekt:
-
Lägg till JAR i kodbasen och implementera den i kodbasdatabasen under en mapp, till exempel"beroenden". Observera att mappnamnet är beroende av kodens bashierarki.
-
Konfigurera pom.xml-projektfilerna enligt följande:
Överordnat projekts pom.xml-fil:
note important IMPORTANT I följande kodfragment ska X.x ersättas med det faktiska versionsnumret och API JAR:s filnamn. Den här informationen är densamma som i steg 3 i installationsprocessen. code language-xml <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-install-plugin</artifactId> <version>2.5.2</version> <configuration> <groupId>com.adobe.fmdita</groupId> <artifactId>api</artifactId> <version>X.x</version> <file>${basedir}/dependencies/fmdita/api-X.x.jar</file> <packaging>jar</packaging> <generatePom>true</generatePom> </configuration> <executions> <execution> <id>inst_fmdita</id> <goals> <goal>install-file</goal> </goals> <phase>clean</phase> </execution> </executions> </plugin>
Den underordnade modulens pom.xml-fil:
code language-xml <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-install-plugin</artifactId> <configuration> <groupId>com.adobe.fmdita</groupId> <artifactId>api</artifactId> <version>3.6</version> <file>${basedir}/../dependencies/fmdita/api-3.6.jar</file> <packaging>jar</packaging> <generatePom>true</generatePom> </configuration> <executions> <execution> <id>inst_fmdita</id> <goals> <goal>install-file</goal> </goals> <phase>clean</phase> </execution> </executions> </plugin>
Konfigurera och använda tjänst-API JAR från den offentliga Maven-databasen
Utför följande steg för att konfigurera och använda JAR för tjänstens API från den offentliga Maven-databasen i dina projekt:
-
Om du vill använda JAR-tjänstens API i ett projekt konfigurerar du AEM Guides pom.xml-databasen.
-
Konfigurera den offentliga Maven-databasen i filen settings.xml i Maven enligt följande:
code language-xml <repository> <id>fmdita-public</id> <name>fmdita-public</name> <url>https://repo.aem-guides.com/repository/fmdita-public</url> </repository>
-
När databasen har konfigurerats lägger du till tjänstens API JAR som ett projektberoende i projektets pom.xml-fil.
note note NOTE Använd samma version av API JAR som det AEM Guides-paket som du har installerat på servern. -
Konfigurera Maven-beroendet så som visas nedan:
code language-xml <dependency> <groupId>com.adobe.fmdita</groupId> <artifactId>api</artifactId> <version>4.0</version> </dependency>
När JAR för tjänst-API har lagts till som ett projektberoende i projektets pom.xml-fil kan du skapa och använda AEM Guides Java API:er i ditt projekt.
Använda API JAR från Maven Central-databasen för AEM Guides as a Cloud Service
För AEM Guides as a Cloud Service har API JAR distribuerats till Maven Central. Du kan använda API JAR utan någon konfiguration.
Om du vill använda API-JAR måste du lägga till beroendet till ditt projekts pom.xml så som visas nedan:
<dependency>
<groupId>com.adobe.aem</groupId>
<artifactId>aem-guides-sdk-api</artifactId>
<version>2022.5</version>
</dependency>
Ytterligare resurser
Nedan följer en lista över andra användbara resurser i AEM Guides som finns på sidan Lär dig mer och support:
- Användarhandbok
- Installations- och konfigureringshandbok
- Snabbstartsguide
- Hjälparkivsida (använd äldre versionsdokumentation)