Buscar pacotes, repositórios e categorias de apps

ducafecatGuia do ecossistema Flutter
Capa de shelf_swagger_ui
Detalhes do pacotev2.0.0

shelf_swagger_ui

Apresente documentação limpa e profissional com Swagger + shelf.

AndroidiOSmacOSWindowsLinux
pub.dev Documentação da API Código-fonte
Downloads em 30 dias
2,1 mil
Curtidas
85
Pontos Pub
145

Instalar pacote

flutter pub add shelf_swagger_ui

Visão geral do pacote

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

Shelf_Swagger_UI é um pacote Flutter/Dart que integra o Swagger UI com o framework de servidor web Shelf, permitindo que desenvolvedores gerem e sirvam documentação de API limpa e interativa. Simplifica o processo de apresentar APIs compatíveis com OpenAPI com uma interface profissional e amigável ao usuário. O pacote é ideal para serviços backend construídos com Shelf, oferecendo exploração em tempo real da API diretamente no navegador. Ele suporta renderização dinâmica de documentação a partir de especificações OpenAPI, facilitando a manutenção e compartilhamento de contratos de API entre equipes.

Casos de uso

  • Oferecer documentação de API interativa
  • APIs REST baseadas em prateleira de documentos
  • Habilite testes em tempo real da API
  • Integrar com fluxos de trabalho de desenvolvimento backend
  • Apoiar a colaboração da equipe no design da API

Principais recursos

  • Integração sem falhas com Shelf
  • Renderização dinâmica do Swagger UI
  • Suporta especificações OpenAPI
  • Documentação interativa baseada em navegador
  • Configuração fácil com mínima configuração

Indicado para

  • Desenvolvedores de backend usando Shelf
  • Equipes que precisam de documentação da API
  • Projetos com APIs compatíveis com OpenAPI
  • Ambientes de desenvolvimento que exigem visualizações ao vivo da API
  • Serviços de backend com suporte ao Flutter

Considerações

  • Requer configuração do servidor Shelf
  • Não destinado ao uso em frontend
  • A documentação deve ser atualizada manualmente se houver mudanças na API
  • Personalização limitada além dos padrões do Swagger UI
  • Mais adequado para desenvolvimento e homologação, não para implantação em produção sem medidas de segurança

README original

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

Shelf SwaggerUI

Present, clean and professional documentation with Swagger + shelf; alt text

Example

Get a YAML or JSON schema file. Ex: (specs/swagger.yaml)

openapi: 3.0.0
info:
  description: "API system"
  version: "1.0.10"
  title: "Swagger Test"
servers:
  - url: http://my-service.info
    description: Remote server
tags:
- name: "user"
  description: "Access to User"

Configure the handler with Shelf:

import 'package:shelf/shelf_io.dart' as io;
import 'package:shelf_swagger_ui/shelf_swagger_ui.dart';

void main(List<String> args) async {
  final path = 'specs/swagger.yaml';
  final handler = SwaggerUI.fromFile(File(path), title: 'Swagger Test');
  var server = await io.serve(handler, '0.0.0.0', 4001);
  print('Serving at http://${server.address.host}:${server.port}');
}

That`s it!

Categorias

OpenAPI & Swagger

Dependências

Lista de dependências 5 itens

Repositório-fonte

Projetos que usam este pacote

Ainda não há dados.