CrudApiPlugin (КрудApiPlugin)

Имитирует API CRUD с хранилищем данных в памяти. Отправляет ответы JSON. Поддерживает CORS для использования между доменами из клиентских приложений. При необходимости имитирует API CRUD, защищенные с помощью Microsoft Entra.

Определение экземпляра подключаемого модуля

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

Пример конфигурации

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

Свойства конфигурации

Параметры командной строки

Никакой

Пример файла API

Ниже приведены несколько примеров файлов API, определяющих API CRUD для получения сведений о клиентах.

Анонимный API CRUD

Ниже приведен пример файла API, который определяет анонимный API CRUD для получения сведений о клиентах.

{
  "$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, защищенный с помощью Microsoft Entra, с помощью одной области

Ниже приведен пример файла API, который определяет API CRUD для получения сведений о клиентах, защищенных с помощью Microsoft Entra. Все действия защищены одной областью. CrudApiPlugin проверяет аудиторию маркеров, издателя и область.

{
  "$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, защищенный с помощью Microsoft Entra, с помощью определенных областей

Ниже приведен пример файла API, который определяет API CRUD для получения сведений о клиентах, защищенных с помощью Microsoft Entra. Действия защищены определенными областями. CrudApiPlugin проверяет аудиторию маркеров, издателя и область.

{
  "$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"]
      }
    }
  ]
}

Свойства файла API

Вы можете ссылаться на dataFile с помощью абсолютного или относительного пути. Прокси-сервер разработки разрешает относительные пути относительно файла определения API.

dataFile должен определить массив JSON. Массив может быть пустым или содержать начальный набор объектов.

Свойства EntraAuthConfig

При настройке свойства auth для entraнеобходимо определить свойство entraAuthConfig. Если вы не определите его, CrudApiPlugin отображает предупреждение и API доступен анонимно.

Вы можете определить entraAuthConfig в файле API и каждом действии API. При определении его в файле API он применяется ко всем действиям. При определении его в действии он переопределяет конфигурацию файла API для этого конкретного действия.

Свойство entraAuthConfig имеет следующие свойства.

Свойства действия

Каждое действие в списке actions имеет следующие свойства.

URL-адрес, указанный в свойстве url, может содержать параметры. Параметры определяются путем упаковки имени параметра в фигурные скобки, например {customer-id}. При маршрутизации запроса прокси-сервер разработки заменяет параметр значением из URL-адреса запроса.

В запросе можно использовать тот же параметр. Например, если определить url как /customers/{customer-id} и query как $.[?(@.id == {customer-id})], прокси-сервер разработки заменяет параметр {customer-id} в запросе значением из URL-адреса запроса.

Если подключаемый модуль не может найти данные в файле данных с помощью запроса, он возвращает 404 Not Found ответ.

Каждый тип действия имеет метод HTTP по умолчанию. Можно переопределить значение по умолчанию, указав свойство method. Например, тип действия get имеет метод GETпо умолчанию. Если вы хотите использовать POST вместо этого, укажите свойство method как POST.

Массив actions определил коллекцию действий, которые требуется макетировать. Можно определить несколько действий для одного и того же метода HTTP и типа действия. Например, можно определить два действия getOne, один из них извлекает клиента по идентификатору и другому по адресу электронной почты. Обязательно определите уникальные URL-адреса для каждого действия.

Действия

Прокси-сервер разработки поддерживает следующие действия для API CRUD.

При создании нового элемента с помощью действия create подключаемый модуль не проверяет его форму и добавляет его в коллекцию данных as-is.

Пример файла данных

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

Следующий шаг