Simular respostas na Internet

Usar o Proxy de Desenvolvimento é a maneira mais fácil de simular uma API. Se você estiver criando o front-end e a API ainda não estiver pronta, você precisará integrar seu back-end a um serviço externo ou deseja testar seu aplicativo com respostas diferentes, o Proxy de Desenvolvimento pode ajudá-lo a simular respostas de API. Ao integrar sua API aos serviços de nuvem, você precisa expor sua API pela Internet para que o serviço de nuvem possa acessá-la. Para expor respostas simuladas pelo Dev Proxy na Internet, use Túneis de Desenvolvimento. Este artigo explica como configurar respostas simuladas a serem expostas na Internet usando Túneis de Desenvolvimento.

Definir respostas simuladas

Para expor respostas simuladas pelo Dev Proxy na internet, comece configurando os mocks.

Importante

Neste momento, os Túneis de Desenvolvimento só dão suporte à exposição de respostas simuladas HTTP na Internet.

Criar respostas simuladas

Crie um arquivo nomeado mocks.json que contenha as respostas simuladas para sua API personalizada. Por exemplo, para simular uma solicitação GET para http://api.contoso.com/products, defina:

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/mockresponseplugin.mocksfile.schema.json",
  "mocks": [
    {
      "request": {
        "url": "http://api.contoso.com/products",
        "method": "GET"
      },
      "response": {
        "headers": [
          {
            "name": "content-type",
            "value": "application/json"
          }
        ],
        "body": [
          {
            "id": 1,
            "name": "Contoso Coffee Beans",
            "price": 12.99
          },
          {
            "id": 2,
            "name": "Contoso Espresso Machine",
            "price": 249.99
          }
        ]
      }
    }
  ]
}

Você também pode simular erros, respostas binárias ou respostas condicionais usando statusCode, nthou bodyFragment.

Configurar o MockResponsePlugin

Crie um arquivo de configuração do Proxy de Desenvolvimento nomeado devproxyrc.json e habilite :MockResponsePlugin

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "MockResponsePlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "mocksPlugin"
    }
  ],
  "urlsToWatch": [
    "http://api.contoso.com/*"
  ],
  "mocksPlugin": {
    "mocksFile": "mocks.json"
  }
}

Importante

Para corresponder a vários pontos de extremidade, use curingas em urlsToWatch. Para garantir a correspondência correta, coloque as simulações mais específicas primeiro em seu mocks.json.

Verificar a configuração

Verifique se as simulações estão funcionando corretamente executando o Proxy de Desenvolvimento e enviando solicitações para a API simulada.

Inicie o Proxy de Desenvolvimento, supondo que você salvou a configuração do Proxy de Desenvolvimento em um arquivo nomeado devproxyrc.json no diretório de trabalho atual:

devproxy

Teste sua simulação enviando uma solicitação por meio do Proxy de Desenvolvimento:

curl -x http://127.0.0.1:8000 http://api.contoso.com/products

Você deve receber a lista de produtos simulada definida em mocks.json.

Expor a API simulada com túneis de desenvolvimento

Para expor respostas simuladas na Internet, inicie um túnel de desenvolvimento mapeado para a porta do Dev Proxy. Configure o túnel para usar o nome de host da API simulada.

Aviso

Permitir acesso anônimo a um túnel de desenvolvimento significa que qualquer pessoa na Internet poderá se conectar ao servidor local, se puder adivinhar a ID do túnel de desenvolvimento.

devtunnel host -p 8000 -a --host-header api.contoso.com

Esse comando mapeia a porta proxy de desenvolvimento para uma URL HTTP pública. Agora você pode acessar sua API simulada de qualquer lugar:

curl http://<your-tunnel-id>-8000.<region>.devtunnels.ms/products