DSERTSS3-3231 - DT TRANSMITE - Implementação do Swagger no endpoint de POST de companies

01. DADOS GERAIS

02. SITUAÇÃO/REQUISITO

• Criação da documentação no formato OpenAPI (Swagger) para exposição do recurso de criação de uma company (filial) no TOTVS Transmite, exposto através das seguintes urls discriminadas por ambiente:
  • https://api-transmite.dev.totvs.app - ambiente de desenvolvimento.
  • https://api-transmite.staging.totvs.app - ambiente de staging
  • https://api-transmite.totvs.app/swagger - ambiente de produção

03. SOLUÇÃO

• Criação e disponibilização do endpoint {{url}}/swagger/company/index.html para exposição do método POST/api/companies

Para utilização deste endpoint é necessário realizar a autenticação inserindo o token através do botão "Authorize".

Uma vez autenticado é possível utilizar a API POST de companies para criação de uma filial na base do TOTVS Transmite. Para tal, os seguintes campos oferecerem possibilidade de preenchimento, conforme visto na aba "Example Value":

Para orientações sobre o preenchimento, bem como as validações produzidas nos campos, é possível visualizar através da aba "Schema" na documentação da API.

Após o preenchimento, enviando a requisição, as respostas a seguir podem ser apresentadas:

• HTTP-STATUS 201 - Created -  Criação da company realizada com sucesso:

• HTTP-STATUS 400 - Bad Request - Quando a requisição não está formada corretamente, no exemplo a seguir o campo CPF/CNPJ não atendeu a regra de preenchimento:

• HTTP-STATUS 422 - Unprocessable Entity - Quando a requisição não pôde ser processada pela aplicação de uma regra de negócio, no exemplo a seguir, o CNPJ informado é inválido:

• HTTP-STATUS 401 - Unauthorized: Quando a requisição é enviada sem token de autenticação.

• HTTP-STATUS 500 - Internal Server Error: Ocorre quando, por exemplo, há indisponibilidade no serviço de banco de dados.

04. DEMAIS INFORMAÇÕES

• Não há

05. ASSUNTOS RELACIONADOS

• Não há