CrudApiPlugin

Simuliert eine CRUD-API mit einem In-Memory-Datenspeicher. Sendet JSON-Antworten. Unterstützt CORS für die domänenübergreifende Verwendung von clientseitigen Anwendungen. Optional simuliert CRUD-APIs, die mit Microsoft Entra geschützt sind.

Definition von Plug-In-instance

{
  "name": "CrudApiPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
  "configSection": "customersApi"
}

Konfigurationsbeispiel

{
  "customersApi": {
    "apiFile": "customers-api.json"
  }
}

Konfigurationseigenschaften

Befehlszeilenoptionen

Keine

API-Dateibeispiel

Es folgen mehrere Beispiele für API-Dateien, die eine CRUD-API für Informationen zu Kunden definieren.

Anonyme CRUD-API

Im Folgenden finden Sie ein Beispiel für eine API-Datei, die eine anonyme CRUD-API für Kundeninformationen definiert.

{
  "$schema": "https://raw.githubusercontent.com/microsoft/dev-proxy/main/schemas/v0.14.1/crudapiplugin.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})]"
    }
  ]
}

CRUD-API, die mit Microsoft Entra mithilfe eines einzelnen Bereichs geschützt ist

Im Folgenden finden Sie ein Beispiel für eine API-Datei, die eine CRUD-API für Informationen zu Kunden definiert, die mit Microsoft Entra geschützt sind. Alle Aktionen werden mit einem Bereich gesichert. CrudApiPlugin überprüft die Tokenzielgruppe, den Aussteller und den Bereich.

{
  "$schema": "https://raw.githubusercontent.com/microsoft/dev-proxy/main/schemas/v0.14.1/crudapiplugin.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})]"
    }
  ]
}

CRUD-API, die mit Microsoft Entra unter Verwendung bestimmter Bereiche gesichert ist

Im Folgenden finden Sie ein Beispiel für eine API-Datei, die eine CRUD-API für Informationen zu Kunden definiert, die mit Microsoft Entra geschützt sind. Aktionen werden mit bestimmten Bereichen geschützt. CrudApiPlugin überprüft die Tokenzielgruppe, den Aussteller und den Bereich.

{
  "$schema": "https://raw.githubusercontent.com/microsoft/dev-proxy/main/schemas/v0.14.1/crudapiplugin.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"]
      }
    }
  ]
}

API-Dateieigenschaften

Sie können mit einem absoluten oder einem relativen Pfad auf die dataFile verweisen. Der Dev Proxy löst relative Pfade relativ zur API-Definitionsdatei auf.

Der dataFile muss ein JSON-Array definieren. Das Array kann leer sein oder einen anfänglichen Satz von Objekten enthalten.

EntraAuthConfig-Eigenschaften

Wenn Sie die auth -Eigenschaft auf entrakonfigurieren, müssen Sie die entraAuthConfig -Eigenschaft definieren. Wenn Sie sie nicht definieren, zeigt CrudApiPlugin eine Warnung an, und die API ist anonym verfügbar.

Sie können für die API-Datei und für jede API-Aktion definieren entraAuthConfig . Wenn Sie sie für die API-Datei definieren, gilt sie für alle Aktionen. Wenn Sie sie für eine Aktion definieren, wird die API-Dateikonfiguration für diese spezifische Aktion überschrieben.

Die entraAuthConfig -Eigenschaft verfügt über die folgenden Eigenschaften.

Aktionseigenschaften

Jede Aktion in der actions Liste verfügt über die folgenden Eigenschaften.

Die in der url -Eigenschaft angegebene URL kann Parameter enthalten. Sie definieren Parameter, indem Sie den Parameternamen in geschweifte Klammern umschließen, {customer-id}z. B. . Beim Weiterleiten der Anforderung ersetzt Dev Proxy den Parameter durch den Wert aus der Anforderungs-URL.

Sie können denselben Parameter in der Abfrage verwenden. Wenn Sie beispielsweise als url/customers/{customer-id} und als query$.[?(@.id == {customer-id})]definieren, ersetzt Dev Proxy den {customer-id} Parameter in der Abfrage durch den Wert aus der Anforderungs-URL.

Wenn das Plug-In die Daten in der Datendatei mithilfe der Abfrage nicht finden kann, gibt es eine 404 Not Found Antwort zurück.

Jeder Aktionstyp verfügt über eine HTTP-Standardmethode. Sie können die Standardeinstellung überschreiben, indem Sie die method -Eigenschaft angeben. Der Aktionstyp verfügt beispielsweise get über die Standardmethode GET. Wenn Sie stattdessen verwenden POST möchten, geben Sie die method -Eigenschaft als an POST.

Das actions Array hat eine Sammlung von Aktionen definiert, die Sie simulieren möchten. Sie können mehrere Aktionen für die gleiche HTTP-Methode und denselben Aktionstyp definieren. Sie können z. B. zwei getOne Aktionen definieren: eine, die einen Kunden anhand seiner ID abruft, und die andere nach seiner E-Mail-Adresse. Achten Sie darauf, für jede Aktion eindeutige URLs zu definieren.

Aktionen

Der Dev Proxy unterstützt die folgenden Aktionen für CRUD-APIs.

Wenn Sie ein neues Element mithilfe einer create Aktion erstellen, überprüft das Plug-In seine Form nicht und fügt es der Datensammlung unverändert hinzu.

Beispiel für eine Datendatei

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