CrudApiPlugin (plugin pour API CRUD)

Simule une API CRUD avec un magasin de données en mémoire. Envoie des réponses JSON. Prend en charge CORS pour l’utilisation inter-domaines à partir d’applications côté client. Si vous le souhaitez, simule les API CRUD sécurisées avec Microsoft Entra.

Définition de l’instance de plug-in

{
  "name": "CrudApiPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
  "configSection": "customersApi"
}

Exemple de configuration

{
  "customersApi": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/crudapiplugin.schema.json",
    "apiFile": "customers-api.json"
  }
}

Propriétés de configuration

Options de ligne de commande

Aucun

Exemple de fichier API

Voici plusieurs exemples de fichiers API qui définissent une API CRUD pour plus d’informations sur les clients.

API CRUD anonyme

Voici un exemple de fichier API qui définit une API CRUD anonyme pour obtenir des informations sur les clients.

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/crudapiplugin.apifile.schema.json",
  "baseUrl": "https://api.contoso.com/v1/customers",
  "dataFile": "customers-data.json",
  "actions": [
    {
      "action": "getAll"
    },
    {
      "action": "getOne",
      "url": "/{customer-id}",
      "query": "$.[?(@.id == {customer-id})]"
    },
    {
      "action": "create"
    },
    {
      "action": "merge",
      "url": "/{customer-id}",
      "query": "$.[?(@.id == {customer-id})]"
    },
    {
      "action": "update",
      "url": "/{customer-id}",
      "query": "$.[?(@.id == {customer-id})]"
    },
    {
      "action": "delete",
      "url": "/{customer-id}",
      "query": "$.[?(@.id == {customer-id})]"
    }
  ]
}

API CRUD sécurisée avec Microsoft Entra à l’aide d’une seule étendue

Voici un exemple de fichier d’API qui définit une API CRUD pour obtenir des informations sur les clients sécurisés avec Microsoft Entra. Toutes les actions sont sécurisées avec une seule étendue. CrudApiPlugin valide l’audience du jeton, l’émetteur et l’étendue.

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/crudapiplugin.apifile.schema.json",
  "baseUrl": "https://api.contoso.com/v1/customers",
  "dataFile": "customers-data.json",
  "auth": "entra",
  "entraAuthConfig": {
    "audience": "https://api.contoso.com",
    "issuer": "https://login.microsoftonline.com/contoso.com",
    "scopes": ["api://contoso.com/user_impersonation"]
  },
  "actions": [
    {
      "action": "getAll"
    },
    {
      "action": "getOne",
      "url": "/{customer-id}",
      "query": "$.[?(@.id == {customer-id})]"
    },
    {
      "action": "create"
    },
    {
      "action": "merge",
      "url": "/{customer-id}",
      "query": "$.[?(@.id == {customer-id})]"
    },
    {
      "action": "update",
      "url": "/{customer-id}",
      "query": "$.[?(@.id == {customer-id})]"
    },
    {
      "action": "delete",
      "url": "/{customer-id}",
      "query": "$.[?(@.id == {customer-id})]"
    }
  ]
}

API CRUD sécurisée avec Microsoft Entra à l’aide d’étendues spécifiques

Voici un exemple de fichier d’API qui définit une API CRUD pour obtenir des informations sur les clients sécurisés avec Microsoft Entra. Les actions sont sécurisées avec des étendues spécifiques. CrudApiPlugin valide l’audience du jeton, l’émetteur et l’étendue.

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/crudapiplugin.apifile.schema.json",
  "baseUrl": "https://api.contoso.com/v1/customers",
  "dataFile": "customers-data.json",
  "auth": "entra",
  "entraAuthConfig": {
    "audience": "https://api.contoso.com",
    "issuer": "https://login.microsoftonline.com/contoso.com"
  },
  "actions": [
    {
      "action": "getAll",
      "auth": "entra",
      "entraAuthConfig": {
        "scopes": ["api://contoso.com/customer.read"]
      }
    },
    {
      "action": "getOne",
      "url": "/{customer-id}",
      "query": "$.[?(@.id == {customer-id})]",
      "auth": "entra",
      "entraAuthConfig": {
        "scopes": ["api://contoso.com/customer.read"]
      }
    },
    {
      "action": "create",
      "auth": "entra",
      "entraAuthConfig": {
        "scopes": ["api://contoso.com/customer.write"]
      }
    },
    {
      "action": "merge",
      "url": "/{customer-id}",
      "query": "$.[?(@.id == {customer-id})]",
      "auth": "entra",
      "entraAuthConfig": {
        "scopes": ["api://contoso.com/customer.write"]
      }
    },
    {
      "action": "update",
      "url": "/{customer-id}",
      "query": "$.[?(@.id == {customer-id})]",
      "auth": "entra",
      "entraAuthConfig": {
        "scopes": ["api://contoso.com/customer.write"]
      }
    },
    {
      "action": "delete",
      "url": "/{customer-id}",
      "query": "$.[?(@.id == {customer-id})]",
      "auth": "entra",
      "entraAuthConfig": {
        "scopes": ["api://contoso.com/customer.write"]
      }
    }
  ]
}

Propriétés du fichier API

Vous pouvez faire référence au dataFile à l’aide d’un chemin absolu ou relatif. Le proxy de développement résout les chemins relatifs relativement au fichier de définition d’API.

Le dataFile doit définir un tableau JSON. Le tableau peut être vide ou contenir un ensemble initial d’objets.

Propriétés EntraAuthConfig

Lorsque vous configurez la propriété auth sur entra, vous devez définir la propriété entraAuthConfig. Si vous ne le définissez pas, CrudApiPlugin affiche un avertissement et l’API est disponible anonymement.

Vous pouvez définir entraAuthConfig sur le fichier API et sur chaque action d’API. Lorsque vous la définissez sur le fichier API, elle s’applique à toutes les actions. Lorsque vous la définissez sur une action, elle remplace la configuration du fichier API pour cette action spécifique.

La propriété entraAuthConfig a les propriétés suivantes.

Propriétés d’action

Chaque action de la liste actions possède les propriétés suivantes.

L’URL spécifiée dans la propriété url peut contenir des paramètres. Vous définissez des paramètres en encapsulant le nom du paramètre dans les accolades, par exemple, {customer-id}. Lors du routage de la requête, le proxy de développement remplace le paramètre par la valeur de l’URL de la requête.

Vous pouvez utiliser le même paramètre dans la requête. Par exemple, si vous définissez le url en tant que /customers/{customer-id} et le query en tant que $.[?(@.id == {customer-id})], le proxy de développement remplace le paramètre {customer-id} dans la requête par la valeur de l’URL de la requête.

Lorsque le plug-in ne trouve pas les données dans le fichier de données à l’aide de la requête, elle retourne une réponse 404 Not Found.

Chaque type d’action a une méthode HTTP par défaut. Vous pouvez remplacer la valeur par défaut en spécifiant la propriété method. Par exemple, le type d’action get a une méthode par défaut de GET. Si vous souhaitez utiliser POST à la place, spécifiez la propriété method comme POST.

Le tableau actions a défini une collection d’actions que vous souhaitez simuler. Vous pouvez définir plusieurs actions pour la même méthode HTTP et le même type d’action. Par exemple, vous pouvez définir deux actions getOne, une qui récupère un client par son ID et l’autre par son adresse e-mail. Veillez à définir des URL uniques pour chaque action.

Actions

Le proxy de développement prend en charge les actions suivantes pour les API CRUD.

Lorsque vous créez un élément à l’aide d’une action de create, le plug-in ne valide pas sa forme et l’ajoute à la collection de données as-is.

Exemple de fichier de données

[
  {
    "id": 1,
    "name": "Contoso",
    "address": "4567 Main St Buffalo, NY 98052"
  },
  {
    "id": 2,
    "name": "Fabrikam",
    "address": "4567 Main St Buffalo, NY 98052"
  }
]

Étape suivante