Objetivo

Esta tarefa tem por objetivo de fornecer a API REST que expõe os endpoints que serão consumidos pelo portalAPI, para a criação de novas empresas e seus devidos serviços.

Regras de Negócio

As regras de negócio implementadas, e descritas nesta sessão, foram definidas dessa maneira visando facilitar o consumo da API por parte do portalAPI, que será o principal cliente da mesma. 

Cria novos ambientes separados para cada empresa

Cada empresa gerada através do endpoint "/companies" cria um ambiente isolado para o cliente. No WSO2, implementamos esse conceito através de multitenancy. 

Cria APIs, aplicativos e a subscrição entre eles

Criação dos principais recursos existentes no sistema, isolados por empresa. Também cria esse laço de subscrição entre eles.  

Importa Swagger

Possui camada de abstração que permite colocar uma URL do swagger no corpo do JSON, a fim de que ao subir uma API, seja possível buscar a sua definição/contrato através dessa URL.

Microserviços

Para cada um dos principais recursos existentes, foi disponibilizado um endpoint:

• /companies - cria empresa
• /apis - cria api
• /applications - cria app
• /subscriptions - subscreve um app para uma api 

Endpoint genérico

O endpoint "/companies" suporta o agrupamento para criação de todos os recursos descritos acima em um mesmo serviço. 

Vantagem: Abstrai alguma lógica que precisaria ser implementada do lado do cliente para a criação de todos os recursos. Única requisição para fazer todo o trabalho

Desvantagem: Menos performático e maior chance de erros.

Documentação detalhada

TotvsAdminSwagger.yaml

Referências

• https://docs.wso2.com/display/AM2xx/apidocs/publisher/index.html
• https://docs.wso2.com/display/AM2xx/apidocs/store/index.html#!/
• https://docs.wso2.com/display/IS530/Calling+Admin+Services
• https://docs.wso2.com/display/AM210/Managing+Tenants
• https://docs.wso2.com/display/IS530/Managing+Tenants+with+APIs