Skip to content
Back to skills

Backend To Frontend Handoff Docs

ASecurity

Entendi. Sou um desenvolvedor backend completando trabalho de API. Minha tarefa é produzir um documento estruturado de handoff que fornece aos desenvolvedores frontend (ou sua IA) contexto completo de negócio e técnico para construir integração/UI sem precisar fazer perguntas.

  • 11 stars
  • 0 votes
  • 0 copies
  • 3 views
  • Added September 8, 2026
developmenttypescriptgoapifrontendbackend

Works with

  • api

Security analysis

A100/100

Pro scans all 2 files and shows the line behind each finding

Scanned September 8, 2026

npx -y skills add artubss/SKILLS-CLAUDE-CODE --skill backend-to-frontend-handoff-docs --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Backend To Frontend Handoff Docs?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Backend To Frontend Handoff Docs
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/artubss-backend-to-frontend-handoff-docs/badge)](https://www.skillsdirectory.com/skills/artubss-backend-to-frontend-handoff-docs)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
# API Handoff Mode

Entendi. Sou um desenvolvedor backend completando trabalho de API. Minha tarefa é produzir um documento estruturado de handoff que fornece aos desenvolvedores frontend (ou sua IA) contexto completo de negócio e técnico para construir integração/UI sem precisar fazer perguntas.

## Quando usar
Após completar trabalho de API backend—endpoints, DTOs, validação, lógica de negócio—execute este modo para gerar documentação de handoff.

## Objetivo
Produzir um documento pronto para copiar e colar com todo o contexto que uma IA frontend precisa para construir UI/integração corretamente e com confiança.

## Entradas
- Código de API completo (endpoints, controllers, services, DTOs, validação).
- Contexto de negócio relacionado da task/user story.
- Qualquer constraint, caso extremo ou armadilha descoberta durante implementação.

## Fluxo de Trabalho

1. **Coletar contexto** — confirme nome da feature, endpoints relevantes, DTOs, regras de auth, e casos extremos.
2. **Criar/atualizar arquivo de handoff** — escreva o documento em `.claude/docs/ai/<feature-name>/api-handoff.md`. Incremente o sufixo de iteração (`-v2`, `-v3`, …) se re-executar após feedback.
3. **Colar template** — preencha cada seção abaixo com dados concretos. Omita subseções apenas quando realmente não aplicável (anote por quê).
4. **Double-check** — garanta que payloads correspondem ao comportamento real da API, escopos de auth são precisos, e enums/validação refletem lógica backend.

## Formato de Saída

Produza um único bloco markdown estruturado como segue. Mantenha denso—sem fluff, sem repetição.

```markdown
# API Handoff: [Nome da Feature]

## Contexto de Negócio
[2-4 frases: Que problema resolve? Quem usa? Por que importa? Inclua qualquer termo de domínio que frontend precisa entender.]

## Endpoints

### [METHOD] /path/to/endpoint
- **Propósito**: [1 linha: o que faz]
- **Auth**: [role/permission obrigatório, ou "public"]
- **Request**:
  ```json
  {
    "field": "type — descrição, constraints"
  }
  ```
- **Response** (sucesso):
  ```json
  {
    "field": "type — descrição"
  }
  ```
- **Response** (erro): [Códigos HTTP e formas, ex: 422 validação, 404 não encontrado]
- **Notas**: [casos extremos, rate limits, paginação, ordenação, qualquer coisa não óbvia]

[Repita para cada endpoint]

## Modelos de Dados / DTOs
[Liste key models/DTOs que frontend receberá ou enviará. Inclua tipos de campo, nullability, enums, e significado de negócio.]

```typescript
// Exemplo de shape para typing frontend
interface ExampleDto {
  id: number;
  status: 'pending' | 'approved' | 'rejected';
  createdAt: string; // ISO 8601
}
```

## Enums & Constantes
[Liste qualquer enum, códigos de status, ou magic values que frontend precisa saber. Inclua rótulos de exibição se relevante.]

| Valor | Significado | Rótulo de Exibição |
|-------|-------------|-------------------|
| `pending` | Aguardando revisão | Pendente |

## Regras de Validação
[Resuma key validation rules que frontend deve espelhar para UX—campos obrigatórios, min/max, formatos, regras condicionais.]

## Lógica de Negócio & Casos Extremos
- [Bullet cada comportamento não óbvio, constraint, ou armadilha]
- [ex: "Usuário pode submeter apenas uma vez por dia", "Itens soft-deleted excluídos por padrão"]

## Notas de Integração
- **Fluxo recomendado**: [ex: "Buscar lista → selecionar item → submeter form → fazer polling para status"]
- **UI Otimista**: [segura ou não, por quê]
- **Caching**: [qualquer header de cache, triggers de invalidação]
- **Real-time**: [eventos websocket, intervalos de polling se aplicável]

## Cenários de Teste
[Key scenarios que frontend deve tratar—happy path, erros, casos extremos. Use como acceptance criteria ou test cases.]

1. **Happy path**: [breve descrição]
2. **Erro de validação**: [o que dispara, resposta esperada]
3. **Não encontrado**: [quando 404 é retornado]
4. **Permissão negada**: [quando 403 é retornado]

## Perguntas Abertas / TODOs
[Qualquer coisa não resolvida, pendendo decisão PM, ou precisa input frontend. Se nenhuma, omita seção.]
```

## Regras
- **SEM OUTPUT DE CHAT**—produza apenas o bloco markdown de handoff, nada mais.
- Seja preciso: tipos, constraints, exemplos—não prosa vaga.
- Inclua payloads de exemplo reais onde útil.
- Destaque comportamentos não óbvios—não assuma que frontend "simplesmente saberá."
- Se backend fez trade-offs ou assumptions, documente-os.
- Mantenha escaneável: headers, tabelas, bullets, code blocks.
- Nenhum detalhe de implementação backend (nenhum path de arquivo, nome de classe, serviços internos) a menos que diretamente relevante para integração.
- Se algo está incompleto ou TBD, diga explicitamente.

## Após Gerar
Escreva o markdown final apenas no arquivo de handoff—não ecoar em chat. (Se a plataforma requer confirmação, referencie o path do arquivo em vez de colar conteúdo.)

Files in this skill

  • README.md8.7 KB
  • SKILL.md4.9 KB

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

View all in development →

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.