Forem: Guarapi

APIs com Guarapi e HTTP/2

João Neto — Thu, 15 Feb 2024 17:35:24 +0000

O HTTP/2 é uma evolução significativa em relação ao seu predecessor, o HTTP/1.1, proporcionando melhorias notáveis na eficiência da comunicação entre clientes e servidores. Neste artigo, exploraremos como o Guarapi, um servidor HTTP para Node.js, oferece suporte ao HTTP/2 e por que a utilização do TLS é fundamental nesse contexto.

Motivos para o Uso do TLS com HTTP/2

O HTTP/2, por padrão, é projetado para ser seguro, e é altamente recomendável utilizar o TLS (Transport Layer Security) para garantir a integridade e a confidencialidade dos dados durante a comunicação. Além disso, muitos navegadores modernos só permitem o uso do HTTP/2 sobre TLS, tornando essencial a implementação desse protocolo de segurança.

No código abaixo, observe como o Guarapi configura o servidor para utilizar o TLS, fornecendo os certificados necessários:

const certs = {
  key: fs.readFileSync(path.resolve('./cert/key.pem')),
  cert: fs.readFileSync(path.resolve('./cert/cert.pem')),
};

const app = guarapi({
  serverOptions: {
    isSSL: true,
    isHTTP2: true,
    allowHTTP1: true,
    ...certs,
  },
});

Suporte ao HTTP/2 no Guarapi

O Guarapi simplifica a implementação do HTTP/2, oferecendo uma configuração clara e direta para habilitar esse protocolo de comunicação eficiente. Ao estabelecer o servidor com isHTTP2: true, você coloca sua aplicação na vanguarda das tecnologias web, proporcionando uma experiência mais ágil aos usuários finais.

Servindo Arquivos Estáticos com HTTP/2: Melhores Práticas

Ao considerar a entrega de arquivos estáticos via HTTP/2, é importante explorar alternativas que otimizem o desempenho. Uma abordagem comum é evitar a transmissão desses arquivos no mesmo socket do servidor Guarapi, buscando soluções mais eficientes. Isso pode ser particularmente crucial em ambientes de produção com alto tráfego.

Uma possível abordagem para aprimorar a entrega de arquivos estáticos no Guarapi é o desenvolvimento de um plugin específico. Esse plugin pode ser projetado para lidar com a transmissão de arquivos estáticos de maneira performática, aproveitando os benefícios do HTTP/2.

Explorar essas otimizações pode resultar em uma experiência de usuário mais rápida e eficiente, aproveitando ao máximo as vantagens do HTTP/2. Lembre-se de adaptar essas práticas conforme as necessidades específicas do seu projeto.

Ao adotar o HTTP/2 com Guarapi e TLS, você estará preparando sua aplicação para um desempenho maior e alinhada às melhores práticas da web moderna.

Recomendações e Recursos Adicionais

Recomendamos a consulta à documentação do Node.js sobre a compatibilidade do HTTP/2, fornecendo links específicos para as seções relevantes:

Essas referências são inestimáveis para aprofundar o entendimento sobre as nuances do HTTP/2 no contexto do Node.js. Elas oferecem insights adicionais aos desenvolvedores que desejam explorar a fundo as melhores práticas e otimizações. Ao incorporar o HTTP/2 com Guarapi e TLS, você estará preparando sua aplicação para um desempenho excepcional, alinhado às práticas mais recentes da web moderna.

Nossas redes:

Plataforma	Link
Reddit	Guarapi Subreddit
Daily.dev	Daily.dev Invite
Discord	Discord Invite
Repositório	Guarapi no GitHub

Os Bastidores do Guarapi - Framework Modular

João Neto — Thu, 08 Feb 2024 14:08:50 +0000

Navegando no Futuro: Frameworks Modulares e as Engrenagens das Prioridades

Vamos explorar mais a fundo a onda dos frameworks modulares, focando especialmente no Guarapi, que está na dianteira dessa revolução. Vamos entender por que a ordem dos plugins não é automática e como isso abre portas para um controle dinâmico via CLI ou até mesmo um admin frontend que ainda está na mesa de ideias.

1. Flexibilidade nos Trilhos com o Guarapi:

No universo dos frameworks modulares, o Guarapi é tipo o maestro da flexibilidade. Com sua abordagem modular, é possível moldar a aplicação conforme o projeto pede, e os plugins entram em cena para um upgrade personalizado.

2. Controle Manual dos Plugins:

A não ordenação automática de plugins no Guarapi é como ter o controle total do palco. Cada desenvolvedor decide a ordem de entrada dos plugins, garantindo que a performance seja um espetáculo otimizado. Isso é puro controle criativo!

3. Reuso de Plugins com a Vibe do Guarapi:

A comunidade Guarapi compartilha a visão de reuso e troca de ideias. Os plugins podem ser como peças valiosas que você pode encaixar conforme o necessário, tudo alinhado com a proposta modular e expansível do Guarapi.

4. Testabilidade na Prática:

A proposta do Guarapi, com seus plugins sob controle, facilita a testabilidade. Os testes unitários podem ser afiados para cada plugin, garantindo uma execução suave e sem tropeços.

5. Admin Frontend em Potencial:

A cereja no bolo é a ideia de um admin frontend para controlar plugins em tempo de execução. Imagina só, conectar e desconectar plugins como quem troca de figurino no backstage. O Guarapi está semeando a ideia de um controle dinâmico para os devs.

6. Rumo ao Futuro:

O Guarapi, com sua abordagem modular e controle manual de plugins, está apontando para o futuro. A visão de um admin frontend adiciona um toque extra de inovação. O controle em tempo de execução é como ter as rédeas da experiência de desenvolvimento nas mãos.

Conclusão: Conduzindo a Orquestra do Desenvolvimento

Os frameworks modulares, especialmente o Guarapi, abrem portas para uma era de controle e personalização no desenvolvimento. Controlar manualmente a ordem dos plugins é uma jogada inteligente, proporcionando um espetáculo de performance otimizado. E a visão de um admin frontend no Guarapi? Isso pode ser um divisor de águas na flexibilidade e no controle em tempo real. Vamos ficar de olho nesse enredo emocionante!

Nossas redes:

Plataforma	Link
Reddit	Guarapi Subreddit
Daily.dev	Daily.dev Invite
Discord	Discord Invite
Repositório	Guarapi no GitHub

Implementando um Plugin de Autenticação para Guarapi

João Neto — Wed, 10 Jan 2024 18:31:58 +0000

Olá!

Gostaria de compartilhar uma Prova de Conceito (POC) de um plugin de autenticação em desenvolvimento para o Guarapi. Este plugin visa oferecer funcionalidades de autenticação e renovação de tokens JWT.

Para mais informações e para colaborar, acesse nosso Discord Guarapi Development e confira o GitHub do Guarapi.

Aqui está uma breve amostra do código do plugin:

import { Plugin, Request } from 'guarapi';
import { Methods } from 'guarapi/dist/lib/router';
import { sign } from 'jsonwebtoken';

interface SingConfig<P extends { sub: string | number }> {
  route: string;
  getJWTPayload: (req: Request) => Promise<P>;
}

export interface GuarapiAuthPluginConfig<P extends { sub: string | number }> {
  signIn?: SingConfig<P>;
  refreshToken?: SingConfig<P>;
  salt: string;
  tokenExpiresIn: string;
  refreshTokenExpiresIn: string;
  issuer: string;
  audience: string;
}

export default function guarapiAuthPlugin<P extends { sub: string | number }>(
  guarapiAuthPluginConfig: GuarapiAuthPluginConfig<P>,
) {
  const { salt, audience, issuer, tokenExpiresIn, refreshTokenExpiresIn, signIn, refreshToken } =
    guarapiAuthPluginConfig;

  const routesMap: Record<string, SingConfig<P> | undefined> = {
    [signIn?.route || '']: signIn,
    [refreshToken?.route || '']: refreshToken,
  };

  async function getTokens(req: Request, route: SingConfig<P>) {
    const { sub, ...jwtPayload } = await route.getJWTPayload(req);

    return {
      token: sign({ sub, ...jwtPayload }, salt, {
        expiresIn: route === signIn ? tokenExpiresIn : refreshTokenExpiresIn,
        audience,
        issuer,
      }),

      refreshToken: sign({ sub, ...jwtPayload }, salt, {
        expiresIn: refreshTokenExpiresIn,
        audience,
        issuer,
      }),
    };
  }

  const plugin: Plugin = (app) => {
    app.use(async (req, res, next) => {
      const route = routesMap[req.url || ''];
      const method = req.method?.toLocaleLowerCase();

      if (route && method === Methods.POST) {
        const tokens = await getTokens(req, route);
        res.json(tokens);
        return;
      }

      next();
    });

    return {
      name: 'guarapiAuthPlugin',
    };
  };

  return plugin;
}

Este plugin permite configurar rotas de autenticação e renovação de tokens JWT, adaptáveis às necessidades do projeto. Ele utiliza o pacote jsonwebtoken para gerar os tokens com base nas configurações fornecidas.

A configuração básica para este plugin é a seguinte:

import { Guarapi, bodyParserPlugin, middlewarePlugin } from 'guarapi';
import guarapiAuthPlugin, { GuarapiAuthPluginConfig } from './guarapi-auth-plugin';

interface PayloadRequest {
  userId: string;
}

export default async function initPlugins(app: Guarapi) {
  const authConfig: GuarapiAuthPluginConfig<{ sub: string; userId: string }> = {
    signIn: {
      route: '/auth/signin',
      getJWTPayload: async (req) =>
        Promise.resolve({ sub: 'teste', userId: (req.body as PayloadRequest)?.userId }),
    },
    refreshToken: {
      route: '/auth/refresh',
      getJWTPayload: async (req) =>
        Promise.resolve({ sub: 'teste', userId: (req.body as PayloadRequest)?.userId }),
    },
    audience: 'teste',
    issuer: 'issuer-1',
    salt: 'secret',
    refreshTokenExpiresIn: '24h',
    tokenExpiresIn: '1h',
  };

  app.plugin(bodyParserPlugin);
  app.plugin(middlewarePlugin);
  app.plugin(guarapiAuthPlugin(authConfig));
}

Estou buscando feedback da comunidade sobre a estrutura, a lógica de funcionamento e possíveis melhorias que podem ser implementadas neste plugin. Sintam-se à vontade para discutir e compartilhar suas opiniões, sugestões ou dúvidas relacionadas a esta POC.

Agradeço antecipadamente por qualquer contribuição ou feedback que possam oferecer!

Nossas redes:

Plataforma	Link
Reddit	Guarapi Subreddit
Daily.dev	Daily.dev Invite
Discord	Discord Invite
Repositório	Guarapi no GitHub

🚀 Crie Aplicativos Web com o Guarapi Rapidamente!

João Neto — Sun, 22 Oct 2023 04:39:15 +0000

Introdução:

Olá! Temos o prazer de anunciar o lançamento da Versão 1.0 do Guarapi e o starter kit @guarapi/create-guarapi-app, uma ferramenta que simplifica o processo de criação de aplicativos web com o Guarapi framework. Se você é um desenvolvedor em busca de uma estrutura eficaz e elegante para criar aplicativos Node.js, esta é a notícia que você estava esperando!

Como Começar:

Usar o @guarapi/create-guarapi-app é fácil. Basta criar um novo aplicativo Guarapi com este único comando:

pnpm create @guarapi/guarapi-app

Escolha um exemplo de projeto de nossos exemplos Guarapi

Como Contribuir:

Estamos sempre abertos a contribuições e feedback da comunidade. Se você encontrar problemas ou tiver sugestões para melhorias, não hesite em abrirmos uma issue no GitHub. Valorizamos sua opinião!

Guarapi v0.1.0: Revolucionando o Desenvolvimento Web com Node.js

João Neto — Wed, 13 Sep 2023 05:07:00 +0000

É com grande empolgação que compartilho as últimas atualizações do Guarapi. Estamos comprometidos em tornar o desenvolvimento web mais simples e eficiente, e nossa mais recente versão, a v0.1.0, traz algumas melhorias empolgantes.

Novidades em Destaque

Plugin de Rotas Integrado

A principal adição nesta versão é a integração de um plugin de rotas robusto. Agora, você pode definir rotas para sua aplicação web de maneira flexível e intuitiva. Lida com diferentes métodos HTTP e padrões de URL com facilidade, economizando tempo e esforço no desenvolvimento de rotas complexas. Dê uma olhada na nossa documentação para aprender como começar a usar esse novo recurso!

Hook de Erro

Outra grande melhoria é a inclusão do hook de erro. Ele permite que você gerencie erros de maneira elegante durante o processamento de solicitações. Seja para registrar erros ou fornecer respostas de erro adequadas, o hook de erro é uma ferramenta essencial para tornar suas aplicações mais robustas e confiáveis.

Próximos Passos

Estamos empolgados com o progresso do Guarapi até agora, mas nosso trabalho está longe de terminar. Aqui estão alguns dos próximos passos que planejamos:

Melhorias Contínuas: Continuaremos aprimorando o Guarapi para oferecer uma experiência de desenvolvimento ainda melhor. Esperamos adicionar mais recursos úteis e aprimorar a usabilidade.
Adicionar Testes: A qualidade é nossa prioridade. Estamos planejando adicionar testes abrangentes para garantir que o Guarapi seja confiável e estável em todos os cenários.
Novas Funcionalidades: Estamos sempre abertos a ideias e contribuições da comunidade. Se você tiver sugestões ou desejar adicionar novos recursos, fique à vontade para contribuir para o projeto.

Estamos entusiasmados com o que o futuro reserva para o Guarapi e mal podemos esperar para ver o que você construirá com essa ferramenta poderosa.

Junte-se a nós na jornada do Guarapi, explore nossa documentação e fique à vontade para contribuir para o projeto no GitHub. Seja parte desta comunidade amigável e inclusiva.

Fique atento às atualizações e evoluções deste framework. Juntos, podemos fazer a diferença no mundo do desenvolvimento web!

Guarapi - Framework Brasileiro

João Neto — Tue, 29 Aug 2023 02:48:43 +0000

Guarapi - Framework Brasileiro

Descubra o Guarapi, um framework revolucionário para desenvolvimento web em Node.js. Neste artigo, mergulhamos fundo no estágio atual de desenvolvimento do Guarapi, explorando funcionalidades emocionantes e oportunidades de colaboração. Acompanhe o progresso deste projeto de código aberto e saiba como fazer parte dessa jornada.

Repositório no GitHub: Guarapi GitHub Repository

Exemplo

import { IncomingMessage, ServerResponse } from "http";
import guarapi, { middleware, logger } from "guarapi";

const app = guarapi();

app.plugin(middleware);
app.plugin(logger);

app.use(async (req, res, next) => {
    app.logger("info", "My debug msg");
    next();
});

app.use(async (req: IncomingMessage, res: ServerResponse) => {
    res.end("ok");
});

app.listen(3000, "0.0.0.0", () => {
    console.log("> Running: http://localhost:3000");
});

O código de exemplo demonstra a estrutura básica de um aplicativo Guarapi. Vamos dar uma olhada nos principais componentes:

Imports: O código começa importando os módulos http e o próprio guarapi. Ele também importa os módulos de middleware e logger.
Criação de uma instância Guarapi: O código cria uma instância do Guarapi chamada app.
Adição de Middleware: O código adiciona dois plugins ao Guarapi: middleware e logger.
Definição de Rotas: Duas rotas são definidas usando o método app.use(). A primeira rota registra uma mensagem de log usando o logger do Guarapi e, em seguida, chama o próximo middleware. A segunda rota simplesmente envia uma resposta "ok" para o cliente. Posteriormente, teremos mais formas de definir rotas.
Inicialização do Servidor: O código inicia o servidor na porta 3000 e no endereço "0.0.0.0".

Funcionalidades Principais

Podemos destacar as seguintes funcionalidades principais do Guarapi até o momento:

Middleware: O Guarapi suporta a inclusão de middleware, como demonstrado pela adição dos plugins middleware e logger. Isso permite que desenvolvedores personalizem o processamento de solicitações HTTP.
Logging: O framework possui um sistema de registro integrado. O exemplo mostra como registrar mensagens de log com diferentes níveis (no caso, "info").
Middleware (Tratamento de Rotas raiz): Rotas são definidas usando o método app.use(), permitindo que os desenvolvedores definam como as solicitações HTTP devem ser manipuladas.

Próximos Passos

Agora, imagine as possibilidades! Você pode fazer parte do futuro deste framework emocionante:

Adição de Recursos: Expandir a funcionalidade do framework adicionando mais recursos, como suporte a autenticação, validação de entrada e roteamento avançado.
Documentação Detalhada: Criar documentação detalhada para que outros desenvolvedores possam entender e utilizar facilmente o Guarapi.
Testes Unitários e de Integração: Implementar testes para garantir a robustez e confiabilidade do framework.
Comunidade e Colaboração: Encorajar a participação da comunidade e receber contribuições para o projeto. Vamos construir algo incrível juntos!

Conclusão

O Guarapi é mais do que um framework - é uma oportunidade de inovação e colaboração. Com um compromisso com a flexibilidade e uma visão ambiciosa, o Guarapi promete simplificar o desenvolvimento de aplicativos web em Node.js. Junte-se a nós nesta emocionante jornada de criação e transformação!

Fique atento às atualizações e evoluções deste framework. Juntos, podemos fazer a diferença no mundo do desenvolvimento web!