Exemple de photos (modèles et modèles de mappage API Gateway)

L'exemple suivant montre une API d'album photo dans API Gateway. Nous fournissons un exemple de transformation des données, des modèles supplémentaires et des modèles de mappage. Pour plus d'informations sur les transformations de données, consultez Présentation des modèles de mappage. Pour plus d'informations sur les modèles et les modèles de mappage dans API Gateway, consultez PetStore modèle de mappage.

Exemple de transformation de données

L'exemple suivant montre comment vous pouvez transformer les données d'entrée relatives à des photos à l'aide d'un modèle de mappage VTL (Velocity Template Language). Pour plus d'informations sur le langage VTL (Velocity Template Language), consultez Apache Velocity - Référence VTL (langue française non garantie).

Données d'entrée	{ "photos": { "page": 1, "pages": "1234", "perpage": 100, "total": "123398", "photo": [ { "id": "12345678901", "owner": "23456789@A12", "photographer_first_name" : "Saanvi", "photographer_last_name" : "Sarkar", "secret": "abc123d456", "server": "1234", "farm": 1, "title": "Sample photo 1", "ispublic": true, "isfriend": false, "isfamily": false }, { "id": "23456789012", "owner": "34567890@B23", "photographer_first_name" : "Richard", "photographer_last_name" : "Roe", "secret": "bcd234e567", "server": "2345", "farm": 2, "title": "Sample photo 2", "ispublic": true, "isfriend": false, "isfamily": false } ] } }
Modèle de mappage de sortie	#set($inputRoot = $input.path('$')) { "photos": [ #foreach($elem in $inputRoot.photos.photo) { "id": "$elem.id", "photographedBy": "$elem.photographer_first_name $elem.photographer_last_name", "title": "$elem.title", "ispublic": $elem.ispublic, "isfriend": $elem.isfriend, "isfamily": $elem.isfamily }#if($foreach.hasNext),#end #end ] }
Données de sortie	{ "photos": [ { "id": "12345678901", "photographedBy": "Saanvi Sarkar", "title": "Sample photo 1", "ispublic": true, "isfriend": false, "isfamily": false }, { "id": "23456789012", "photographedBy": "Richard Roe", "title": "Sample photo 2", "ispublic": true, "isfriend": false, "isfamily": false } ] }

Modèle d'entrée pour les données photographiques

Vous pouvez définir un modèle pour vos données d'entrée. Ce modèle d'entrée nécessite que vous chargiez une photo et spécifie un minimum de 10 photos par page. Vous pouvez utiliser ce modèle d'entrée pour générer un kit SDK ou pour activer la validation d'une demande pour votre API.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PhotosInputModel",
  "type": "object",
  "properties": {
    "photos": {
      "type": "object",
      "required" : [
      "photo"
      ],
      "properties": {
        "page": { "type": "integer" },
        "pages": { "type": "string" },
        "perpage": { "type": "integer", "minimum" : 10 },
        "total": { "type": "string" },
        "photo": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": { "type": "string" },
              "owner": { "type": "string" },
              "photographer_first_name" : {"type" : "string"},
              "photographer_last_name" : {"type" : "string"},
              "secret": { "type": "string" },
              "server": { "type": "string" },
              "farm": { "type": "integer" },
              "title": { "type": "string" },
              "ispublic": { "type": "boolean" },
              "isfriend": { "type": "boolean" },
              "isfamily": { "type": "boolean" }
            }
          }
        }
      }
    }
  }
}

Modèle de sortie pour les données photographiques

Vous pouvez définir un modèle pour vos données de sortie. Vous pouvez utiliser ce modèle comme modèle de réponse de méthode, ce qui s'avère nécessaire quand vous générez un kit SDK fortement typé pour l'API. Cela entraîne la conversion (cast) de la sortie en une classe appropriée en Java ou Objective-C.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PhotosOutputModel",
  "type": "object",
  "properties": {
    "photos": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "photographedBy": { "type": "string" },
          "title": { "type": "string" },
          "ispublic": { "type": "boolean" },
          "isfriend": { "type": "boolean" },
          "isfamily": { "type": "boolean" }
        }
      }
    }
  }
}

Modèle de mappage d'entrée pour les données photographiques

Vous pouvez définir un modèle de mappage pour modifier les données d'entrée. Vous pouvez modifier les données d'entrée pour poursuivre l'intégration des fonctions ou les réponses d'intégration.

#set($inputRoot = $input.path('$'))
{
  "photos": {
    "page": $inputRoot.photos.page,
    "pages": "$inputRoot.photos.pages",
    "perpage": $inputRoot.photos.perpage,
    "total": "$inputRoot.photos.total",
    "photo": [
#foreach($elem in $inputRoot.photos.photo)
      {
        "id": "$elem.id",
        "owner": "$elem.owner",
        "photographer_first_name" : "$elem.photographer_first_name",
        "photographer_last_name" : "$elem.photographer_last_name",
        "secret": "$elem.secret",
        "server": "$elem.server",
        "farm": $elem.farm,
        "title": "$elem.title",
        "ispublic": $elem.ispublic,
        "isfriend": $elem.isfriend,
        "isfamily": $elem.isfamily
      }#if($foreach.hasNext),#end
			
#end
    ]
  }
}