CrudApiPlugin

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

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

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

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

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

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

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

None

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

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

Анонимный API CRUD

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

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

API CRUD, защищенный с помощью Microsoft Entra с помощью одного область

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

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

API CRUD, защищенный с помощью Microsoft Entra с использованием определенных областей

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

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

Вы можете ссылаться на , 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 действия подключаемый модуль не проверяет его форму и не добавляет его в коллекцию данных "как есть".

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

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