Examen à l'aide d'un fichier de description OpenAPI

Vous pouvez utiliser un fichier de description OpenAPI pour examiner automatiquement votre OpenAPI, ce qui offre une meilleure couverture en vous permettant de mettre à jour les paramètres et d'inclure tous les nœuds finaux. Cela garantit un examen plus approfondi et plus précis, ce qui permet d'identifier les problèmes potentiels sur l'ensemble de l'API.

Procédure

  1. Accédez à Configuration > API et sélectionnez OpenAPI.
  2. Sélectionnez Fichier de description OpenAPI et cliquez sur Ajouter un fichier de description.
  3. Saisissez l'URL ou cliquez sur Parcourir pour choisir le fichier sur votre disque local, puis cliquez sur Continuer. AppScan accepte uniquement les formats JSON ou YAML pour le fichier de description.
    AppScan analyse les données et les charge dans le tableau des Paramètres supplémentaires.
  4. Modifiez les valeurs des paramètres pour améliorer les performances de l'examen automatique en faisant correspondre les paramètres à leurs URL pertinentes.
    Seuls les paramètres mis à jour sont utilisés pendant l'examen. Par conséquent, il est fortement recommandé de mettre à jour les paramètres pour une meilleure couverture de l'examen, ce qui garantit que tous les nœuds finaux sont couverts et évite les échecs de requête.
  5. Configurez l'authentification API si nécessaire. En fonction de votre fichier de description, les liens Configurer la clé API ou Configurer l'authentification de base (HTTP) ou les deux s'affichent pour configurer l'authentification. Si les liens ne s'affichent pas, vous pouvez configurer manuellement l'authentification via la clé API, l'Authentification HTTP, ou la Gestion des connexions, ce qui permet de s’assurer que l'examen couvre la plupart des nœuds finaux et d'éviter les échecs de requête.
  6. Une fois la configuration terminée, vous pouvez lancer un examen.
    AppScan lance un examen automatique.
    Remarque : Si vous ajoutez un fichier local plutôt qu'une URL à une configuration, vous ne pouvez pas l'exporter en tant que fichier SCANT (modèle), car le fichier de description ne peut pas être inclus dans un modèle. Vous devez supprimer le fichier de description ou l'enregistrer en tant que fichier SCAN.

Que faire ensuite

Une fois l'exploration terminée, vous pouvez afficher les paramètres trouvés pendant l'examen sur la page Remplissage automatique du formulaire, ainsi que les requêtes envoyées et les paramètres trouvés sur la page Données.