rest assured

Testar e validar serviços REST em Java é mais difícil do que em linguagens dinâmicas como Ruby e Groovy. REST Assured traz a simplicidade do uso dessas linguagens para o domínio Java.

Notícias

• 05/07/2024: REST Assured 5.5.0 é lançado com várias correções de bugs e um novo módulo de extensão Scala 3. Consulte o log de alterações para obter mais detalhes.
• 08/12/2023: REST Assured 5.4.0 é lançado com várias correções de bugs e um módulo de extensão Kotlin para Spring WebTest. Consulte o log de alterações para obter mais detalhes.
• 08/09/2023: REST Assured 5.3.2 é lançado com várias correções de bugs, melhor suporte Spring MockMvc, melhor suporte para versões mais recentes do Spring Security etc.

Notícias mais antigas

Exemplos

Aqui está um exemplo de como fazer uma solicitação GET e validar a resposta JSON ou XML:

 get ( "/lotto" ). then (). assertThat (). body ( "lotto.lottoId" , equalTo ( 5 ));

Obtenha e verifique todos os IDs dos vencedores:

 get ( "/lotto" ). then (). assertThat (). body ( "lotto.winners.winnerId" , hasItems ( 23 , 54 ));

Usando parâmetros:

 given ().
    param ( "key1" , "value1" ).
    param ( "key2" , "value2" ).
when ().
    post ( "/somewhere" ).
then ().
    body ( containsString ( "OK" ));

Usando X-Path (somente XML):

 given ().
    params ( "firstName" , "John" , "lastName" , "Doe" ).
when ().
    post ( "/greetMe" ).
then ().
    body ( hasXPath ( "/greeting/firstName[text()='John']" )).

Precisa de autenticação? REST Assured fornece vários mecanismos de autenticação:

 given (). auth (). basic ( username , password ). when (). get ( "/secured" ). then (). statusCode ( 200 );

Obtendo e analisando um corpo de resposta:

 // Example with JsonPath
String json = get ( "/lotto" ). asString ();
List < String > winnerIds = from ( json ). get ( "lotto.winners.winnerId" );
    
// Example with XmlPath
String xml = post ( "/shopping" ). andReturn (). body (). asString ();
Node category = from ( xml ). get ( "shopping.category[0]" );

REST Assured suporta qualquer método HTTP, mas tem suporte explícito para POST , GET , PUT , DELETE , OPTIONS , PATCH e HEAD e inclui especificação e validação, por exemplo, de parâmetros, cabeçalhos, cookies e corpo facilmente.

Documentação

• Começando
• Guia de uso (clique aqui para documentação legada)
• Javadoc
• Fique tranquilo Javadoc
• Fique tranquiloMockMvc Javadoc
• XmlPathJavadoc
• JsonPathJavadoc
• Notas de versão
• Perguntas frequentes

Apoio e discussão

Junte-se à lista de discussão em nosso grupo do Google.

Ligações

• Registro de alterações
• REST garantido no openhub
• Lista de discussão para perguntas e suporte