Thanks for your feedback!
EDIT
Relatório de Maturidade, especificação de API e Smart Recommendations
Nessa tela (veja como chegar nela) você pode:
-
analisar a qualidade da API e ver as regras que ela viola, quando for o caso;
-
visualizar a especificação da API (Swagger);
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:
-
Acesse a tela Discovery, clicando no menu lateral esquerdo.
-
Localize a API que quer analisar e clique no ícone
. -
Na aba GENERAL DATA, no canto superior direito da tela, clique em Latest Revision.
-
Nesse caso, você verá o relatório de maturidade e especificação da revisão mais recente.
-
Alternativamente, logo abaixo, na aba DETAILS, clique no ícone
na linha da revisão correspondente.
O ícone aparece nos dois modos de visualização (Environments ou Revisions).
-
|
No modo Environments, o ícone será desabilitado quando não houver revisão da API implantada no ambiente.
|
As informações são apresentadas em duas abas: QUALITY ANALYSIS e SPECIFICATION.
Score 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
Para entender o score da sua API, clique na aba QUALITY ANALYSIS.
Nesta aba você encontra uma lista com as regras que compõem o score.
Veja a descrição de cada regra, o peso que ela tem no cálculo do score e as violações encontradas.
Cada regra é exibida em uma linha da tabela que contém as seguintes colunas:
-
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
contextefield.-
WEIGHT ON SCORE: percentual que o campo representa no score total de maturidade;
-
SEVERITY OF VIOLATIONS: grau de severidade da violação encontrada (None, Low, Medium ou High) e o percentual penalizado.
-
VIOLATIONS: ao clicar em
, um modal com a lista de de regras violadas é exibido. O ícone fica desabilitado quando não há violações.
Para cada recomendação, um ícone colorido indica o seu grau de severidade.
-
|
Para visualizar apenas as regras violadas, habilite o botão de toggle View only violated rules. |
Visualizar o swagger
Acesse a aba SPECIFICATION para visualizar a especificação da API (Swagger), com seus respectivos endpoints.
Share your suggestions with us!
Click here and then [+ Submit idea]