jwtWebApi

API de autenticação JWT com refresh token, modelagem segura e boas práticas em .NET

---

Sumário

• jwtWebApi
  • Sumário
  • Sobre o Projeto
  • Tecnologias Utilizadas
  • Como Rodar o Projeto
  • Configuração de Ambiente
  • Exemplos de Uso da API
    • 1. Registrar Usuário
    • 2. Login e obtenção de tokens
    • 3. Acesso a endpoint protegido
    • 4. Renovar JWT usando refresh token
  • Como rodar
  • Fluxo de Autenticação e Refresh Token
  • Boas Práticas e Segurança
• 🌐 Mensagens de Erro e Validação com Tradução Automática
  • ✅ Como funciona
  • 📥 Exemplo de envio com cultura definida
  • 🔎 Exemplo de resposta de erro (en-US)
  • 📁 Estrutura de Localização
  • ⚙️ Configuração em Program.cs
  • Exemplo usando placeholdes Program.cs.
  • Como Contribuir

---

Sobre o Projeto

Esta API demonstra autenticação baseada em JWT (JSON Web Token) com suporte a refresh token, controle de usuários, roles e boas práticas de modelagem e segurança.
Ideal para estudos, portfólio e como base para aplicações reais.

---

Tecnologias Utilizadas

• .NET 9
• ASP.NET Core Web API
• Entity Framework Core
• JWT Bearer Authentication
• User Secrets (para configuração segura)
• Swagger (para documentação e testes)

---

Como Rodar o Projeto

1. Clone o repositório

   git clone https://github.com/seuusuario/jwtWebApi.git
   cd jwtWebApi

2. Configure o banco de dados

   • Altere a connection string no appsettings.json ou use User Secrets.

3. Configure os secrets do JWT

   dotnet user-secrets set "JWT:Secret_Key" "sua-chave-secreta"
   dotnet user-secrets set "JWT:Audience" "www.seuapp.com"

4. Rode as migrations

   dotnet ef database update

5. Execute a aplicação

   dotnet run

6. Acesse o Swagger

   • Normalmente em: https://localhost:5001/swagger

---

Configuração de Ambiente

• appsettings.json: configure connection string e outras opções.
• User Secrets: use para armazenar chaves sensíveis (JWT, etc).

---

Exemplos de Uso da API

1. Registrar Usuário

POST /api/v1/auth/register
Content-Type: application/json

{
  "login": "edy",
  "username": "Edy",
  "password": "Senha123!",
  "confirmePassword": "Senha123!",
  "email": "[email protected]",
  "roles": ["Admin"]
}

2. Login e obtenção de tokens

POST /api/v1/auth/login
Content-Type: application/json

{
  "login": "edy",
  "password": "Senha123!"
}

Resposta:

{
  "accessToken": "<jwt_token>",
  "refreshToken": "<refresh_token>"
}

3. Acesso a endpoint protegido

GET /api/v1/user/profile
Authorization: Bearer <jwt_token>

4. Renovar JWT usando refresh token

POST /api/v1/auth/refresh
Content-Type: application/json

{
  "refreshToken": "<refresh_token>"
}

Resposta:

{
  "accessToken": "<novo_jwt_token>",
  "refreshToken": "<novo_refresh_token>"
}

Migrations e EF Core

Como rodar

dotnet restore
dotnet ef database update
dotnet run

Fluxo de Autenticação e Refresh Token

1. Usuário faz login e recebe um JWT e um refresh token.
2. Usa o JWT para acessar endpoints protegidos.
3. Quando o JWT expira, usa o refresh token para obter um novo JWT.
4. O refresh token antigo é invalidado e um novo é emitido.

---

Boas Práticas e Segurança

• Refresh tokens são salvos no banco, relacionados ao usuário.
• JWTs são assinados com chave secreta segura.
• Roles são usadas para autorização de endpoints.
• Dados sensíveis nunca ficam hardcoded no código.
• Validação de entrada e tratamento de erros implementados.

---

🌐 Mensagens de Erro e Validação com Tradução Automática

Esta API possui suporte completo a localização (i18n) para mensagens de validação de dados, retornando os erros automaticamente no idioma apropriado com base na cultura definida na requisição.

✅ Como funciona

• A API utiliza Data Annotations em conjunto com arquivos .resx de tradução.
• A cultura (CultureInfo) é detectada automaticamente via header HTTP Accept-Language.
• Atualmente são suportados os idiomas:
  • pt-BR (Português do Brasil)
  • en-US (Inglês Americano)

📥 Exemplo de envio com cultura definida

Ao fazer uma requisição HTTP para a API, basta definir o cabeçalho:

Accept-Language: en-US

Ou:

Accept-Language: pt-BR

A resposta de erro de validação será retornada automaticamente no idioma solicitado.

🔎 Exemplo de resposta de erro (en-US)

{
  "errors": {
    "Password": [
      "Password must be at least 6 characters long."
    ]
  }
}

📁 Estrutura de Localização

Os arquivos de tradução estão localizados na pasta:

/Resources/JwtWebApi.Dto.UserDto.[cultura].resx
/Resources/Outros..

Por exemplo:

• JwtWebApi.Dto.UserDto.en-US.resx
• JwtWebApi.Dto.UserDto.pt-BR.resx

⚙️ Configuração em Program.cs

builder.Services.AddLocalization(options => options.ResourcesPath = "Resources");

builder.Services.AddControllers()
    .AddDataAnnotationsLocalization();

app.UseRequestLocalization(new RequestLocalizationOptions
{
    DefaultRequestCulture = new RequestCulture("pt-BR"),
    SupportedCultures = new[] { new CultureInfo("pt-BR"), new CultureInfo("en-US") },
    SupportedUICultures = new[] { new CultureInfo("pt-BR"), new CultureInfo("en-US") }
});

Exemplo usando placeholdes Program.cs.

Como substituir values em tempo de execução.

/Resoures/OrderMessages.resx

<data name="OrderNotification" xml:space="preserve">
  <value>Your order ("{0}") has been shipped and is on its way to "{1}".</value>
</data>

app.MapGet("/{orderId}/{address}", (IStringLocalizerFactory factory, string orderId, string address) =>
{
    var localizer = factory.Create("OrderMessages", typeof(Program).Assembly.GetName().Name!);

    //logica para obter a mensagem de notificação do pedido

    // Substituindo os placeholders {0} e {1}

    string message = string.Format(localizer["OrderNotification"], orderId, address);

    return message;
});

Dúvidas ou sugestões?
Abra uma issue ou entre em contato!

---

Como Contribuir

1. Faça um fork do projeto
2. Crie uma branch (git checkout -b feature/nova-feature)
3. Commit suas alterações (git commit -am 'Adiciona nova feature')
4. Push para a branch (git push origin feature/nova-feature)
5. Abra um Pull Request

---