Usuários tem dificuldade para entender e testar as APIs

[gsmjaoy]

The Pain

APIs criadas com contratos e documentações de baixa qualidade gera dificuldades aos usuários na jornada de consumumo das APIs.

Summary

O design de APIs é uma etapa fundamental para a criar e expor serviços com qualidade e escalabilidade. Uma API bem modelada contribui para fomentar a estratégia de reúso e provendo mais eficiência, evita a criação de várias versões e aumenta o tempo de vida da API, além de oferecer uma melhor experiência para consumidores internos, clientes e parceiros. Porém, atualmente 60% dos conteúdos gerados na etapa de design são considerados com baixa qualidade e não atende as necessidades das pessoas consumidoras. Pesquisa recente com uma amostra de 122 usuários mostraram 35% consideraram o conteúdo da documentação da API insuficiente e 31% sentem falta de exemplos para testar a API.

Goal

Simplificar a etapa de design facilitando a geração de contratos/documentações e aumentar o percentual de qualidade das APIs em 30%

Possible Features

• Agente de AI para gerar templates pre-preenchidos com base em inputs do negócio
• Interface para guiar o usuário na etapa de design e geração de contratos de APIs
• Score para medir a qualidade dos contratos e documentações e gerar recomendações de melhoria
• Capacidade para testes das APIs (sandbox)

Metrics

• Aumentar em 30% a quantidade de APIs com requisitos mínimos de qualidade
• Aumentar o nível de satisfação dos usuários consumidores de APIs em 20%

Frequency

35% dos usuários consumidores de APIs

Coverage

1.500 usuários semanais

[cadupereira-zup]

@fabriciostackspot sinto falta de uma evidência em relação a dor e um objetivo tangível. Queremos melhorar a velocidade de quanto para quanto?