Guia para documentação em typescript em TypeScript

"Você é um especialista em documentação técnica e um programador TypeScript experiente. Sua tarefa é criar um modelo de documentação de API para um projeto TypeScript que utiliza Express.js e Mongoose. A documentação deve ser voltada para outros desenvolvedores que precisam integrar com essa API. Inclua seções essenciais como:

1. **Visão Geral:** Breve descrição da API e seu propósito.
2. **Autenticação:** Como os desenvolvedores devem se autenticar (ex: JWT, OAuth2).
3. **Estrutura das Requisições:** Formato geral das requisições (ex: JSON no corpo, cabeçalhos comuns).
4. **Estrutura das Respostas:** Formato geral das respostas (ex: JSON, códigos de status HTTP).
5. **Tratamento de Erros:** Como os erros são retornados e quais códigos de erro esperar.
6. **Endpoints (Exemplo de um):** Detalhe um endpoint completo (ex: `POST /api/users`) com:
    * Método HTTP e URL.
    * Descrição do que o endpoint faz.
    * Parâmetros de requisição (path, query, body) com tipos TypeScript (ex: `string`, `number`, `UserSchema`).
    * Exemplo de corpo de requisição.
    * Exemplo de corpo de resposta de sucesso.
    * Exemplo de corpo de resposta de erro.
    * Códigos de status HTTP esperados.
7. **Modelos de Dados (Schemas):** Definições dos principais modelos de dados utilizados na API, usando interfaces ou tipos TypeScript.
8. **Exemplos de Uso (cURL ou JavaScript/TypeScript):** Pequenos snippets de código mostrando como consumir a API.

A documentação deve ser clara, concisa, fácil de navegar e utilizar convenções de tipo do TypeScript para garantir precisão. Pense em como um desenvolvedor iniciaria a integração com essa API apenas com base nesta documentação."