Documentatie AEM Guides Documentatie voor AEM Guides

Inleiding id1761C0007W7

Last update: Sun Jul 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Onderwerpen:
API-introductie

Gemaakt voor:

Ervaren
Ontwikkelaar

Adobe Experience Manager Guides \ (later die als AEM Guides wordt bedoeld ) is een oplossing van begin tot eind, ondernemingsoplossing die Adobe Experience Manager \ (AEM ) toelaat om componenteninhoudbeheeroplossing \ (CCMS ) mogelijkheden voor op DITA-Gebaseerde inhoudsverwezenlijking en levering te hebben. Klanten hebben via programmacode toegang tot AEM Guides-workflows om deze te integreren met andere bedrijfstoepassingen. Deze API's kunnen ook door Adobe partners worden gebruikt om de waardepositie van AEM Guides te verbeteren door de functionaliteit ervan uit te breiden of door deze te integreren met andere toepassingen of services.

AEM Guides API's

De AEM Guides API's zijn in twee indelingen beschikbaar: HTTP en Java. Deze API's maken belangrijke functies van AEM Guides toegankelijk voor toepassingsontwikkelaars. Met deze functies kunnen ontwikkelaars hun eigen plug-ins maken om de workflows uit de doos uit te breiden. De API's zijn beschikbaar voor het beheren van uitvoer voor DITA-inhoud, het werken met DITA-kaarten, het toevoegen van voorwaardelijke kenmerken aan profielen op mapniveau en het converteren van HTML- en Word-documenten naar DITA-indeling.

De JAR's installeren op uw lokale Apache Maven-opslagplaats install-jar-local

Als u de JAR-bestanden wilt kunnen gebruiken die door AEM Guides beschikbaar zijn gesteld, moet u ze installeren in uw lokale Apache Maven-opslagruimte. Voer de volgende stappen uit om de JAR's te installeren op uw locatie in Maven-opslagplaats:

Pak de inhoud van het AEM Guides-pakket (.zip) uit op uw lokale systeem.

Navigeer naar de volgende map in het pad voor geëxtraheerde inhoud bij de opdrachtprompt:

code language-none
`\jcr_root\libs\fmdita\osgi-bundles\install`

Voer de volgende opdracht uit om de API-bundel te installeren in uw lokale Maven-opslagruimte:

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
In het bovenstaande bevel, zou X.x met het daadwerkelijke versieaantal in de parameters van Dfile en van de Versie moeten worden vervangen.

\ (Facultatieve ) installeert gebiedsdeel in uw lokale Gemaakt plaats van het project. U kunt dit bereiken door een map in uw Maven-project te maken en vervolgens de opdracht mvn install uit te voeren die in de vorige stap met de volgende aanvullende parameter is gegeven:

code language-none
`-DlocalRepositoryPath=<path_to_project_repository>`

Vervolgens voegt u een repository -element toe aan het bovenliggende pom.xml-bestand als u de lokale opslagmap van het project toegankelijk wilt maken voor het Maven-constructieproces:

code language-xml
`<repositories> <repository> <id>project-repository</id> <url>file://${project.basedir}/repository</url> </repository> </repositories>`

Dit proces installeert de API JARs in de lokale Maven bewaarplaats.

De service-API JAR gebruiken in een Maven-project

Nadat u de API JAR's in uw lokale Maven-opslagruimte hebt geïnstalleerd, voert u de volgende stappen uit om de JAR in uw projecten te gebruiken:

Voeg JAR aan uw codebasis toe en bewijs het aan de gegevensopslagplaats van de codebasis onder een omslag, zoals "gebiedsdelen". De mapnaam is afhankelijk van de basishiërarchie van de code.

Configureer de bestanden met projectpom.xml als volgt:

Het bestand pom.xml van het bovenliggende project:

note important
IMPORTANT
In het volgende codefragment moet X.x worden vervangen door het eigenlijke versienummer en de bestandsnaam van de API JAR. Deze informatie zal het zelfde als gegeven in Stap 3 van het installatieproceszijn.

code language-xml

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>

<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>

Het bestand pom.xml van de onderliggende module:

code language-xml

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>`

<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>

De service-API JAR van de openbare Maven-opslagplaats configureren en gebruiken

Voer de volgende stappen uit om de dienst API JARs van de openbare Maven bewaarplaats in uw projecten te vormen en te gebruiken:

Als u de service-API JAR in een project wilt gebruiken, configureert u de openbare Maven-opslagruimte van AEM Guides in het bestand pom.xml.

Configureer de openbare Maven-opslagplaats in het bestand settings.xml van Maven als volgt:

code language-xml
`<repository> <id>fmdita-public</id> <name>fmdita-public</name> <url>https://repo.aem-guides.com/repository/fmdita-public</url> </repository>`

Zodra de bewaarplaats opstelling is, voeg de dienst API JAR als projectgebiedsdeel in het pom.xml- dossier van het project toe.

note note
NOTE
Gebruik dezelfde versie van de API JAR als het AEM Guides-pakket dat u op de server hebt geïnstalleerd.

Vorm de Geweven gebiedsdeel zoals hieronder getoond:

code language-xml
`<dependency> <groupId>com.adobe.fmdita</groupId> <artifactId>api</artifactId> <version>4.0</version> </dependency>`

Zodra de dienst API JAR als projectgebiedsdeel in het pom.xml- dossier van het project wordt toegevoegd, kunt u AEM Guides Java APIs in uw project bouwen en gebruiken.

API JAR gebruiken vanuit de Maven Central-opslagplaats voor AEM Guides as a Cloud Service

Voor AEM Guides as a Cloud Service is de API JAR geïmplementeerd in Maven Central. U kunt de API JAR zonder enige installatie gebruiken.

NOTE

De naamgevingsconventie van de API-jar is bijgewerkt volgens de naamgevingsconventie voor invoegtoepassingen voor cloud.

Om API JAR te gebruiken, moet u het gebiedsdeel aan pom.xml van uw project toevoegen zoals hieronder getoond:

<dependency>
   <groupId>com.adobe.aem</groupId>
   <artifactId>aem-guides-sdk-api</artifactId>
   <version>2022.5</version>
</dependency>

NOTE

Aangezien de pakketten in de API JAR nog steeds hetzelfde zijn, is geen codewijziging vereist om deze API JAR in de bestaande wolkenprojecten te gebruiken.

Aanvullende bronnen

Na is een lijst van andere nuttige middelen van AEM Guides, die op 🔗 pagina Leren & van de Steun beschikbaar zijn:

Handboek
Installatie- en configuratiehandleiding
Handleiding voor snel starten
de Archiefpagina van het Archief van de Hulp\ (de documentatie van de toegangsoudere versie )

recommendation-more-help

11125c99-e1a1-4369-b5d7-fb3098b9b178