Janela de Criação de API

Permitirá incorporar uma API ao catálogo de APIs disponíveis. Registar uma API Externa no sistema ou disponibilizar uma Ontologia como API.

Para isso, deverão introduzir-se os seguintes campos:  Nome: Identificador único da API.

 Pública: Definirá se a API é acessível para todos os utilizadores ou se é necessário conceder uma autorização aos mesmos para que possam subscrever-se.

 Versão: Versão da API. Recalcula-se automaticamente a partir do nome da mesma.  Categoría: Categoria genérica a que pertencerá a API e que facultará a sua localização.  API Externa: Selecionar-se-á se se pretende registar uma API no sistema. Se selecionar

esta opção, desativar-se-á o campo Ontologia, apresentar-se-á o campo EndPoint base Externo e mostrar-se-á a secção de Autorização e Operações correspondente ao registo de uma API Externa.

 Ontologia: Se não se seleccionar a opção anterior, isto é, para o caso de uma API disponibilizada a partir de uma Ontologia, este controlo ativar-se-á e será através deste controlo com o qual se selecionará essa Ontologia. Para os utilizadores com o rol de Colaborador, apenas serão apresentadas as ontologias das quais são proprietários, enquanto para os utilizadores com o rol de Adminsitrador, apresentar-se-ão todas as ontologias públicas e ativas.

Se se selecionar uma Ontologia, gerar-se-ão automaticamente o nome (e o cálculo da versão correspondente), assim como o caminho de cada uma das operações (a partir do nome da API e da sua versão).

 Imagem: Representará a API no sistema. Se não se introduzir nenhuma, se~rá

apresentada uma imagem por defeito.

 EndPoint: Endereço EndPoint do serviço que será gerado automaticamente a partir do identificador e da versão da API.

 Enpoint base externo: Endereço EndPoint do serviço final a registar no sistema. Apresentar-se-á se estiver a registar uma API externa no sistema.

 Descrição: Descrição geral da API.

 Autenticação: Para o caso de se tratar de uma API Externa, apresentar-se-á uma secção que permitirá introduzir atributos de autenticação.

 Operações. Toda a informação associada a cada uma das operações disponíveis na API. Ao introduzir uma API externa ou ao disponibilizar-se uma Ontologia, apresentar-se-á uma ou outra interface.

O Nome, Versão, EndPoint, EndPoint Externo, Descrição como Meta-Inf são campos obrigatórios, não permitindo ao sistema realizar a introdução se algum se encontra vazio. A seguir examinaremos a janela correspondente à disponibilização de uma Ontologia como API.

A parte correspondente às operações:

Através de cada um dos botões que representam cada Operação, pode selecionar-se as operações que estarão disponíveis na API.

Após carregar nos controlos pretendidos, deverá introduzir-se a informação necessária, neste caso a informação que descreva cada uma das operações selecionadas.

Após introduzir a informação necessária e carregar no botão Criar, realizar-se-á a criação do novo registo e navegar-se-á pela janela de Consulta de Dados da API,

Deverá introduzir-se a URL do EndPoint base externo para a invocação da API Externa.

Este tipo de APIs poderá ter uma autenticação associada (para a invocação do serviço subjacente) que pode configurar-se através da secção de Autenticação:

Se se selecionar o tipo Básico, adicionar-se- uma entrada na secção de Autenticação:

Poderá editar e eliminar essa autenticação, assim como atribuir-lhe um valor ao atributo Authorization

Este valor terá que indicar um dos atributos do pedido para servir como valor de autenticação. Caso introduza um valor por defeito, o mesmo será utilizado para a invocação da API Externa, sem que o utilizador tenha de informar a mesma.

Caso a invocação seja feita através de Cabeçalhos, ao efetuar a seleção, a interface apresentará o seguinte:

Ao carregar em Adicionar Cabeçalho, adicionar-se-ão os distintos Cabeçalhos que serão necessários introduzir no pedido à API. Tal como anteriormente mencionado, podem ser atribuídos valores por defeito para que não seja necessário a introdução dos mesmos por parte do utilizador na invocação.

Após introduzir os dados e guardar, estes aparecerão na interface.

Uma vez efetuada a Autenticação, será necessário definir pelo menos uma operação. Para isso, utilizar-se-á a secção Operações:

Devem introduzir-se os campos correspondentes:

- Método da operação HTTP (GET, POST, PUT ou DELETE). - Nome da operação (identificador).

- EndPoint Base Operação:Se for introduzido, para a operação em questão substituirá o EndPoint do API.

- Rota relativa: constroi-se para completar a rota do EndPoint geral. - Descrição : Informação que descreve a operação.

Após carregar em guardar, apresentar-se-á a operação criada na lista:

Poder-se-ão editar os respetivos dados gerais ou eliminar a operação. Se se carregar no nome da operação, asparecerão as opções:

Poderá adicionar-se os restantes parâmetros associados à operação, os headers assim como queryparams.

Após carregar no botão correspondente, apresentar-se-á a interface de entrada:

Deverá introduzir-se uma série de dados: - Nome: Identificação do Parâmetro

- Condição: Se for exigido (o parâmetro é obrigatório), se for opcional (não é necessário que se informe, mas será necessário tê-lo em conta) ou constante (o parâmetro introduzir-se-á na invocação independentemente se o utilizador o informa ou não).

- Tipo: Tipo de dados do atributo, em princípio string, boolean ou number.

- Valor: Valor do atributo, se pretender a respetiva indicação. Caso a condição seja constante, será obrigatório.

- Descrição: Informação sobre o parâmetro introduzido.

Poder-se-á modificar e eliminar todos os parâmetros introduzidos anteriormente.

Para o caso dos Cabeçalhos, o procedimento será idêntico.

Uma vez introduzidos todos os dados necessários, se se carregar em criar, finalizar-se-á o registo da API Externa.