Relatório de Maturidade, especificação de API e Smart Recommendations

tela com relatório de maturidade especificação de API e Smart Recommendations

Nessa tela (veja como chegar nela) você pode:

Clique nos links acima para detalhes de cada funcionalidade ou veja o vídeo abaixo para uma visão geral:

Como acessar a tela

Para acessar a tela que exibe o relatório de maturidade, especificação e Smart Recommendations, siga os passos abaixo:

  1. Acesse a tela Discovery, clicando no menu lateral esquerdo.

  2. Localize a API que quer analisar e clique no ícone icon visualize.

  3. Clique na aba DOCUMENTATION.

    • Você verá o relatório de maturidade e especificação da revisão mais recente. Clique no número da revisão para a qual deseja ver o relatório de maturidade e especificação.

    • Alternativamente, clique na aba DEPLOYMENTS para ver as revisões implantadas em cada ambiente. Clique no número da revisão para a qual deseja ver o relatório de maturidade e especificação.

No modo Environments, o ícone icon visualize será desabilitado quando não houver revisão da API implantada no ambiente.

As informações são apresentadas em duas abas: SPECIFICATION e PREVIEW.

Score de maturidade

cabeçalho do relatório de maturidade

O score de maturidade é calculado com base em um conjunto de critérios, ou regras (Rules), que avaliam o grau de maturidade da API.

O cálculo segue uma fórmula que atribui pesos para cada regra, aplicando penalidades no score quando os critérios determinados pelas regras não são atingidos.

O resultado é exibido em uma escala percentual, juntamente com um conceito, que classificam o grau de conformidade da API com as regras estabelecidas.

Tais regras, com suas respectivas descrições e pesos em relação ao cálculo do score, são exibidas na aba QUALITY ANALYSIS.

Ao lado do score, você encontra:

  • a revisão da API para a qual o relatório foi gerado,

  • os ambientes nos quais a API está implantada e

  • o botão para pedir a geração de exemplos de aplicação das recomendações, que ficam disponíveis para download, feitos com base em Inteligência Artificial (Smart Recommendations).

Analisando a qualidade das suas APIs

Aba SPECIFICATION

Nesta aba você encontra uma lista com violações que compõem o score.

A lista de violações está disponível apenas para APIs do tipo REST.

As violações estão dividas por níveis, apresentados em abas:

  • HIGH VIOLATION: violações graves que impactam significativamente o score de maturidade da API.

  • MEDIUM VIOLATION: violações de impacto médio.

  • LOW VIOLATION: violações de baixo impacto.

Cada aba lista as violações encontradas naquele nível de severidade, em uma lista com as colunas:

  • LINE: número da linha na especificação da API onde a violação foi encontrada.

  • VIOLATION: descrição da violação encontrada.

  • Coluna com as ações possíveis para cada violação:

    • ícone representando um documento com uma lupa: ver a regra que foi violada:

      • RULE ID: código da regra.

      • DESCRIPTION: descrição da regra, com informações sobre o seu objetivo e fundamentação. Contém os campos context e field.

      • WEIGHT ON SCORE: percentual que o campo representa no score total de maturidade;

Visualizando a especificação da API

Acesse a aba PREVIEW para visualizar a especificação da API (Swagger), com seus respectivos endpoints.

aba Preview

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]