Documentation AEM Guides Documentation d’AEM Guides

Présentation id1761C0007W7

Last update: Fri Jan 12 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Rubriques :
API Introduction

Créé pour :

Experienced
Developer

Guides Adobe Experience Manager (ultérieurement appelés Guides d’AEM) est une solution d’entreprise de bout en bout qui permet à Adobe Experience Manager (AEM) d’avoir des fonctionnalités de solution de gestion de contenu de composant (CCMS) pour la création et la diffusion de contenu basées sur DITA. Les clients peuvent accéder aux processus AEM Guides par programmation à l’aide des API AEM Guides pour les intégrer à d’autres applications d’entreprise. Ces API peuvent également être utilisées par les partenaires d’Adobe pour améliorer la proposition de valeur des Guides d’AEM en étendant ses fonctionnalités ou en l’intégrant à d’autres applications ou services.

API AEM Guides

Les API AEM Guides sont disponibles dans deux formats : HTTP et Java. Ces API exposent les fonctions clés des Guides d’AEM aux développeurs d’applications. Grâce à ces fonctions, les développeurs peuvent créer leurs propres plug-ins pour étendre les workflows prêts à l’emploi. Les API sont disponibles pour la gestion des sorties pour le contenu DITA, l’utilisation de mappages DITA, l’ajout d’attributs conditionnels aux profils au niveau du dossier et la conversion de documents HTML et Words au format DITA.

Installation des fichiers JAR sur votre référentiel Apache Maven local install-jar-local

Pour pouvoir utiliser les fichiers JAR exposés par AEM Guides, vous devez les installer sur votre référentiel Apache Maven local. Pour installer les fichiers JAR sur votre référentiel Maven d’emplacement, procédez comme suit :

Extrayez le contenu du fichier de package AEM Guides (.zip) sur votre système local.

Dans l’invite de commande, accédez au dossier suivant dans le chemin d’accès au contenu extrait :

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

Exécutez la commande suivante pour installer le lot API dans votre référentiel Maven local :

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
Dans la commande ci-dessus, X.x doit être remplacé par le numéro de version réel dans les paramètres Dfile et Dversion.

(Facultatif) Installez la dépendance dans le référentiel de votre projet Maven local. Pour ce faire, créez un dossier dans votre projet Maven, puis exécutez le mvn install , fournie à l’étape précédente avec le paramètre supplémentaire suivant :

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

Ensuite, pour exposer le dossier de référentiel local du projet au processus de création Maven, ajoutez une repository dans le fichier pom.xml parent, comme illustré ci-dessous :

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

Ce processus installe les fichiers JAR de l’API dans le référentiel Maven local.

Utilisation du fichier JAR de l’API de service dans un projet Maven

Après avoir installé les fichiers JAR d’API dans votre référentiel Maven local, procédez comme suit pour utiliser le fichier JAR dans vos projets :

Ajoutez le fichier JAR à votre base de code et validez-le dans le référentiel de base de code sous un dossier, tel que "dependencies". Notez que le nom du dossier dépend de votre hiérarchie de base de code.

Configurez les fichiers pom.xml du projet comme suit :

Fichier pom.xml du projet parent :

note important
IMPORTANT
Dans le fragment de code suivant, X.x doit être remplacé par le numéro de version réel et le nom de fichier JAR de l’API. Ces informations sont identiques à celles fournies à l’étape 3 de la processus d'installation.

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>

Fichier pom.xml du module Enfant :

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>

Configuration et utilisation du JAR de l’API de service à partir du référentiel Maven public

Effectuez les étapes suivantes pour configurer et utiliser les fichiers JAR de l’API de service du référentiel Maven public dans vos projets :

Pour utiliser le fichier JAR de l’API de service dans un projet, configurez le référentiel Maven public AEM Guides dans votre fichier pom.xml.

Configurez le référentiel Maven public dans le fichier settings.xml de Maven comme suit :

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

Une fois le référentiel configuré, ajoutez le fichier JAR de l’API de service en tant que dépendance de projet dans le fichier pom.xml du projet.

note note
NOTE
Utilisez la même version du fichier JAR d’API que le package AEM Guides que vous avez installé sur le serveur.

Configurez la dépendance Maven comme illustré ci-dessous :

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

Une fois que le fichier JAR de l’API de service est ajouté en tant que dépendance de projet dans le fichier pom.xml du projet, vous pouvez créer et utiliser les API Java Guides AEM dans votre projet.

Utilisation du fichier JAR d’API du référentiel central Maven pour AEM Guides as a Cloud Service

Pour AEM Guides as a Cloud Service, le fichier JAR de l’API a été déployé dans Maven Central. Vous pouvez utiliser le fichier JAR de l’API sans configuration.

NOTE

La convention d’affectation des noms du fichier JAR de l’API a été mise à jour conformément à la convention d’affectation des noms des modules complémentaires de cloud.

Pour utiliser le fichier JAR de l’API, vous devez ajouter la dépendance au fichier pom.xml de votre projet, comme illustré ci-dessous :

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

NOTE

Comme les packages à l’intérieur du fichier JAR de l’API sont toujours identiques, aucun changement de code n’est nécessaire pour utiliser ce fichier JAR de l’API dans les projets cloud existants.

Ressources supplémentaires

Vous trouverez ci-dessous une liste d’autres ressources utiles des AEM Guides, disponibles sur la page Formation et assistance page :

Guide de l’utilisateur
Guide d'installation et de configuration
Guide de démarrage rapide
Page d’aide archivée (accéder à l’ancienne documentation de version)

recommendation-more-help

11125c99-e1a1-4369-b5d7-fb3098b9b178