[SoapUi] Removendo comentários &quot;Optional&quot; em Web Services
Autor: Diogo Souza | Publicado: 2014-02-14T11:00:00-03:00

O SoapUI é uma ferramenta de geração de testes client criada para facilitar a vida tanto de desenvolvedores quanto dos testers de Web Services. Através dela, o usuário tem a possibilidade de gerar projetos a partir da URL do WSDL do serviço. Através disso uma requisição de ação (request action) será gerada com os parâmetros do método requerido já carregados inicialmente.






Independente da tecnologia WS usada, o SoapUI tem o poder de reconhecer os parâmetros, em vista da universalidade do xml usada na especificação. Além disso, é possível observar também a presença do comentários <!--Optional:--> que vem precedidos de cada campo. Como mostrado na figura abaixo.



Figura 1. Código exemplo de request action no SoapUi


Esse tipo de comentário existe para o caso em que o número mínimo de ocorrências para o parâmetro é zero. Se o elemento for obrigatório o SoapUi não exibe nada acima. E é ainda onde entra a questão... Como fazer?
Suponha que você tenha um WSDL semelhante ao exibido na listagem abaixo:

&lt;xsd:element name="inserirPessoa"&gt;
  &lt;xsd:complexType&gt;
    &lt;xsd:sequence&gt;
      &lt;xsd:element name="id" type="xsd:int" minOccurs="1" maxOccurs="1" /&gt;
      &lt;xsd:element name="email" type="xsd:string" minOccurs="0" maxOccurs="1" /&gt;
    &lt;/xsd:sequence&gt;
  &lt;/xsd:complexType&gt;
&lt;/xsd:element&gt;


efinição dos atributos minOccurs e maxOccurs pode ser justificada da seguinte maneira:
minOccurs="0" maxOccurs="1" -&gt; significa opcional;
minOccurs="1" maxOccurs="1" -&gt; significa obrigatório.

A utilização do maxOccurs não é obrigatória, logo, você pode usar apenas o atributo "minOccurs" setado com o valor 1 e tudo vai funcionar perfeitamente também.

O resultado na geração do XML de entrada no SoapUi será algo semelhante a:

&lt;soapenv:Body&gt;
  &lt;xsd:inserirPessoa&gt;
    &lt;xsd:id&gt;?&lt;/xsd:id&gt;
    &lt;!--Optional:--&gt;
    &lt;xsd:email&gt;?&lt;/xsd:email&gt;
  &lt;/xsd:inserirPessoa&gt;
&lt;/soapenv:Body&gt;


O situação muda um pouco de cor quando lidamos com a geração de WS utilizando annotations java da especificação JEE atreladas aos famosos EJBs. Neste caso, a anotação @WebService permite que você mapeie um POJO simples com todos os atributos sendo automaticamente associados aos parâmetros do serviço. Por exemplo, considere a classe simples abaixo:

public class Aluno {
    private int id;
    private String nome;
    
    // get's e set's
}


Você poderá ter o mesmo efeito empregado usando uma anotação também do pacote do JaxB:
public class Aluno {
    private int id;
    @XmlElement(required = true, nillable = false)
    private String nome;
    
    // get's e set's
}


O atributo required diz que o valor é obrigatório e o atributo nillable diz que o valor não poderá ser nulo.

Conclusão
As abordagens são relativamente simples, mas compensam o uso e conhecimento por facilitar a vida de quem irá testar ou receber o Web Service. A anotação dá a impressão de que o campo é opcional quando não é.

Em algumas versões das api's de WS o exemplo com annotations pode não funcionar. Se isso acontecer então solicite a atualização das bibliotecas. Alguns erros do tipo acontecem porque a versão não contempla os respectivos fixes. :)