📝 Documentação de APIs com Scalar!
O Scalar é uma excelente alternativa ao Swagger para documentar sua API. Ele utiliza o padrão OpenAPI para apresentar todas as especificações dela de maneira fácil e intuitiva.
Dá pra agrupar e descrever como cada endpoint funciona, adicionando exemplos de requests/responses/erros. Ele também oferece suporte a diferentes client libraries e métodos de autenticação.
Os exemplos a seguir foram retirados da documentação do Syki, um projeto open source que estou desenvolvendo, voltado para o gerenciamento acadêmico de faculdades. Até o momento ele possui cerca de 70 endpoints, que podem ser acessados aqui.
0️⃣ Interface moderna
1️⃣ Fácil navegação e busca por termos
2️⃣ Realização de requests (estilo Insomnia/Postman)
3️⃣ Suporte a múltiplos exemplos de requests/responses/erros
4️⃣ Múltiplos métodos de autenticação (JWT, ApiKey, OAuth2...) e client libraries (C#, Node, Python...)
Conclusão
Documentações bem feitas e ricas em detalhes facilitam a vida de todo mundo, então vale muito a pena adicionar o Scalar na sua API!
Se gostou e quer ver mais conteúdos assim, me segue no LinkedIn e no GitHub, vlw!
Muito legal! Vou estudar para aplicar no trabalho, estou fazendo o back e o front, por conta dos prazos a documentação tem ficado por último, infelizmente, mas tenho que fazer o quanto antes.
Muito obrigada por compartilhar.
tem geracao automatica a partir de codigo assim como o swagger tem oara varios frames e linguagens?
Meio preocupante se pensar em longo prazo quando você olha a foto do escritorio dos desenvolvedores..rs Mas enfim, parece bem legal, talvez pegue! Porém, Postman e Swagger são muito bons e dominam o mercado.
muito bom, nao conhecia essa