Sandbox com Wiremock

As APIs mais novas possuem seus endpoints de sandbox criados utilizando Wiremock como ferramenta. Permitindo, assim, maior agilidade na criação de atualização de APIs de sandbox e maior flexibilidade nas funcionalidades que podemos implementar por meios de stubs.

Stubs

Um stub é um conjunto de especificações que o servidor utiliza para mockar uma request e uma response que o servidor é capaz de processar.

O stub consiste em:

• Request
  • Um path que recebe a requisição;
  • Headers e seus valores;
  • O verbo esperado para aquele path;
  • Uma OpenApi Specification com o body esperado, caso necessário.
• Response
  • Um header de retorno
  • Um código de retorno
  • Um body de retorno

Essa específicação é então processada e servida como uma API Rest.

Response específica do Wiremock

Quando uma requisição HTTP chega no servidor, o Wiremock busca por um stub compatível, validando os headers e o payload. Caso seja encontrado um stub compatível, o retorno é o específicado no stub(e por conseguinte, na documentação do produto no API reference).

Caso não seja encontrado um stub compatível, seja por não possuir os headers específicados ou pelo body não estar condizente com a documentação, o wiremock irá retornar 404 - Not Found e um payload text/plain contendo o stub mais próximo encontrado a divergência marcada com does not match.