Buscar pacotes, repositórios e categorias de apps

Detalhes do pacotev0.1.5

shelf_cors_headers

Middleware de cabeçalhos CORS para Shelf.

AndroidiOSWebmacOSWindowsLinux
Downloads em 30 dias
41,7 mil
Curtidas
41
Pontos Pub
140

Instalar pacote

flutter pub add shelf_cors_headers

Visão geral do pacote

Orientação gerada a partir de informações públicas. Apenas para referência.

Shelf CORS Headers é um pacote de middleware para o framework Shelf que simplifica a adição de cabeçalhos de Compartilhamento de Recursos de Origem Cruzada (CORS) em respostas HTTP. Ele permite que aplicações do lado do servidor construídas com Shelf manipulem de forma segura solicitações entre origens diferentes, configurando origens permitidas, métodos, cabeçalhos e credenciais. O pacote se integra perfeitamente em servidores baseados em Shelf existentes, oferecendo uma solução leve e configurável para gerenciar políticas CORS em serviços web em múltiplas plataformas.

Casos de uso

  • Habilitar solicitações de origem cruzada em APIs baseadas em Shelf
  • Protegendo serviços web com políticas de acesso controlado
  • Suporte a aplicativos de frontend hospedados em domínios diferentes
  • Integrando CORS em backends do Flutter web
  • Tratamento automático de solicitações de pré-voo

Principais recursos

  • Origens permitidas configuráveis
  • Suporte para cabeçalhos e métodos personalizados
  • Tratamento automático de solicitações de pré-voo OPTIONS
  • Integração fácil com roteadores Shelf
  • Configuração flexível para credenciais e idade máxima

Indicado para

  • Desenvolvedores usando Shelf para lógica de backend
  • Desenvolvedores Flutter construindo APIs da web
  • Equipes implementando serviços RESTful seguros
  • Aplicações que exigem controle granular do CORS
  • Projetos de Dart do lado do servidor direcionados para múltiplas plataformas

Considerações

  • Requer entendimento básico dos padrões CORS
  • Não adequado para uso independente no lado do cliente
  • A configuração deve ser cuidadosamente gerenciada em produção
  • Não inclui validação de solicitação além do CORS
  • Limitado a ambientes de servidor baseados em prateleira

README original

Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.

CORS headers middleware for Shelf

A Shelf middleware to add CORS headers to shelf responses.

Features

  • Handles preflight requests.
  • Allows override of default headers.
  • Allows user to provide their own origin checker function.

Usage

A simple usage example:

import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart';
import 'package:shelf_cors_headers/shelf_cors_headers.dart';

void main() async {
  var handler = const Pipeline()
      // Just add corsHeaders() middleware.
      .addMiddleware(corsHeaders())
      .addHandler(_requestHandler);

  await serve(handler, 'localhost', 8080);
}

Response _requestHandler(Request request) {
  return Response.ok('Request for "${request.url}"');
}
Override Headers
import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart';
import 'package:shelf_cors_headers/shelf_cors_headers.dart';

void main() async {
  // optionally override default headers
  final overrideHeaders = {
    ACCESS_CONTROL_ALLOW_ORIGIN: 'example.com',
    'Content-Type': 'application/json;charset=utf-8'
  };

  var handler = const Pipeline()
      // Just add corsHeaders() middleware and pass your header overrides.
      .addMiddleware(corsHeaders(headers: overrideHeaders))
      .addHandler(_requestHandler);

  await serve(handler, 'localhost', 8080);
}

Response _requestHandler(Request request) {
  return Response.ok('Request for "${request.url}"');
}
Custom origin checker

Your origin checker function should consume a string as a parameter(the value of ORIGIN header) and return a boolean value indicating if this middleware should process the request from that origin.

import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart';
import 'package:shelf_cors_headers/shelf_cors_headers.dart';

// define our origin checker
bool dontCheckCNNRequests(String origin) {
  if (origin.contains('cnn.com')) return false;
  return true;
}

void main() async {
  // optionally override default headers
  final overrideHeaders = {
    'Content-Type': 'application/json;charset=utf-8'
  };

  var handler = const Pipeline()
      // Just add corsHeaders() middleware and pass your origin checker
      .addMiddleware(corsHeaders(headers: overrideHeaders, originChecker: dontCheckCNNRequests))
      .addHandler(_requestHandler);

  await serve(handler, 'localhost', 8080);
}

Response _requestHandler(Request request) {
  return Response.ok('Request for "${request.url}"');
}

You can also use the inbuilt originOneOf which takes a list of origins to check:

import 'package:shelf/shelf.dart';
import 'package:shelf/shelf_io.dart';
import 'package:shelf_cors_headers/shelf_cors_headers.dart';

// define our origin checker
final listChecker = originOneOf(['https://cnn.com', 'https://dart.dev'])

void main() async {
  // optionally override default headers
  final overrideHeaders = {
    'Content-Type': 'application/json;charset=utf-8'
  };

  var handler = const Pipeline()
      // Just add corsHeaders() middleware and pass your origin checker
      .addMiddleware(corsHeaders(headers: overrideHeaders, originChecker: listChecker))
      .addHandler(_requestHandler);

  await serve(handler, 'localhost', 8080);
}

Response _requestHandler(Request request) {
  return Response.ok('Request for "${request.url}"');
}

Categorias

Dependências

Lista de dependências 1 itens

Repositório-fonte

Projetos que usam este pacote