...
| URL (voir variables ci-dessus) | Module/API | Méthode | Utilisation |
|---|---|---|---|
url_authn_app_tickets | serveur OAuth | Récupération du Jeton JWT pour authentification des API | |
| url_api_ins_ext/gestion/inscription/${etab}/${codeApprenant} | INS EXT | lireInscriptions | Récupération du dossier de l'apprenant et de ses inscriptions |
| url_api_ins/gestion/inscriptions/${etab}/${codeApprenant}/${codeVoeu}/certificat-de-scolarite | INS | imprimerCertificatDeScolarite | Récupération du certificat de scolarité |
| url_api_ins_ext/gestion/inscriptions/${etab}/${codeApprenant}/${codeVoeu}/${codePiece}/contenu | INS EXT | contenuPiece | Récupération de la photo de l'étudiant |
url_api_chc/cursus-dca?codeApprenant={codeApprenant} | CHC | lireCursusApprenant | Récupération du cursus |
| url_api_coc/etablissements/${etab}/periodes/${codePeriode}/apprenants/${codeApprenant}/chemins/${chemin} | COC | listerCursusPubliableApprenant | Récupération des notes et résultats de l'étudiant |
| url_api_pai/pai/attestation-de-paiement/${etab}/${codeApprenant}/${codePeriode} | PAI | imprimerAttestationDePaiement | Récupération de l'attestation de paiement |
Tester une API
Nous allons voir comment tester le bon fonctionnement d'une API en la requêtant "à la main".
...
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
# Forcer l'utilisation de la version 5.4.0
# /!\ IMPORTANT /!\ A vérifier avant chaque génération sous peine d'obtenir des imports non valides
openapi-generator-cli version-manager set 5.4.0
# INS EXT YAML
npx @openapitools/openapi-generator-cli generate -i inscription-ext-api-v1-1.2.0.yaml -g java -o C:/tmp/openapi-generator/ -p apiPackage=fr.univlorraine.pegase.api.insext -p modelPackage=fr.univlorraine.pegase.model.insext -p dateLibrary=java17-localdatetime
# PIECE EXT YAML
npx @openapitools/openapi-generator-cli generate -i piece-ext-api-v1-1.1.0.yaml -g java -o C:/tmp/openapi-generator/ -p apiPackage=fr.univlorraine.pegase.api.pieceext -p modelPackage=fr.univlorraine.pegase.model.pieceext -p dateLibrary=java17-localdatetime
# INS GESTION YAML
npx @openapitools/openapi-generator-cli generate -i ins-gestion-api-v5-20.0.0.yaml -g java -o C:/tmp/openapi-generator/ -p apiPackage=fr.univlorraine.pegase.api.insgestion -p modelPackage=fr.univlorraine.pegase.model.insgestion -p dateLibrary=java17-localdatetime
# CHC YAML
npx @openapitools/openapi-generator-cli generate -i chc-application-api-v6-6.2.0.yml -g java -o C:/tmp/openapi-generator/ -p apiPackage=fr.univlorraine.pegase.api.chc -p modelPackage=fr.univlorraine.pegase.model.chc -p dateLibrary=java17-localdatetime
# COC PUBLICATION YAML
npx @openapitools/openapi-generator-cli generate -i coc-publication-api-v2-2.0.0.yml -g java -o C:/tmp/openapi-generator/ -p apiPackage=fr.univlorraine.pegase.api.coc -p modelPackage=fr.univlorraine.pegase.model.coc -p dateLibrary=java17-localdatetime
# PAI YAML
npx @openapitools/openapi-generator-cli generate -i pai-api-v1-21.0.0.yaml -g java -o C:/tmp/openapi-generator/ -p apiPackage=fr.univlorraine.pegase.api.pai -p modelPackage=fr.univlorraine.pegase.model.pai -p dateLibrary=java17-localdatetime
|
...