maira-cli
MairaCLI é uma ferramenta para desenvolvedores projetada para gerar automaticamente documentação Swagger para endpoints, interceptando solicitações e respostas durante os testes dos endpoints da API.
Listado em categorias:
Ferramentas de desenvolvimentoCategoriasCódigo aberto
Descrição
MairaCLI é uma ferramenta para desenvolvedores projetada para gerar automaticamente documentação Swagger para endpoints de API, interceptando requisições e respostas durante os testes.
Como usar maira-cli?
Para usar o MairaCLI, instale-o via npm, inicie o servidor proxy dentro do seu projeto de backend, configure os detalhes necessários no arquivo config.json e faça requisições ao seu backend através do servidor proxy. Após fazer as requisições, gere a documentação usando o comando fornecido.
Recursos principais de maira-cli:
1️⃣
Gera automaticamente documentação Swagger para endpoints de API
2️⃣
Intercepta requisições e respostas para documentação precisa
3️⃣
Cria arquivos de configuração para rotas do projeto
4️⃣
Gera links de pré-visualização da documentação
5️⃣
Suporta cabeçalhos de autenticação personalizados
Por que usar maira-cli?
| # | Caso de uso | Status | |
|---|---|---|---|
| # 1 | Gerar documentação de API para projetos de backend | ✅ | |
| # 2 | Testar endpoints de API enquanto os documenta | ✅ | |
| # 3 | Criar documentação Swagger para microsserviços | ✅ | |
Desenvolvido por maira-cli?
MairaCLI é desenvolvido por uma comunidade de colaboradores no GitHub, com o objetivo de simplificar o processo de documentação de API para desenvolvedores.