Skip to main content

Roadmap

AI API Documentation Generator

Gerar explicações, exemplos e markdown a partir do que já tens no Junny (requests, coleções, OpenAPI), com IA opcional e controlos explícitos de privacidade — o produto continua útil sem qualquer provider.

Stub backend

Fase: roadmap

Roadmap para Generate Docs a partir de requests/coleções/OpenAPI com preview markdown, export e IA opcional — privacy-first, sem envio automático de credenciais.

ia-opcionalprivacy-firstnucleo-util-sem-ia

Fluxo principal

  1. selecionar request ou collection
  2. clicar Generate Docs
  3. IA (ou motor local futuro) gera documentação editável

Exemplo REST (stub)

GET /users

Secções típicas geradas

  • endpoint description
  • auth explanation
  • examples
  • payload explanation
  • response explanation

Providers futuros

OpenAI · OpenRouter · Ollama · Anthropic · modelos locais

Componentes UI planejados

  • GenerateDocsButton
  • DocsPreview
  • MarkdownViewer
  • ExampleGenerator

Backend planejado

/modules/ai-docs
  providers
  prompts
  generators

Segurança

  • nunca enviar automaticamente secrets, passwords ou tokens aos providers

MVP

  • generate endpoint docs
  • generate examples
  • markdown generation
  • collection documentation

Fora do arranque

  • publicação autónoma de docs
  • IA cloud obrigatória
  • telemetria sobre conteúdo gerado
  • auto publish sem revisão

UI futura em /features/ai-docs