nenuphar_cli

Visão geral do pacote

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

O Nenuphar CLI é uma ferramenta de linha de comando para gerar especificações OpenAPI e código Dart a partir de definições de API, especialmente projetada para integrar com o Dart Frog. Desenvolvido pela Very Good CLI, ele simplifica o desenvolvimento backend para frontend ao automatizar a criação de código cliente seguro por tipo com base em esquemas OpenAPI. A ferramenta suporta múltiplas plataformas, incluindo Android, iOS, Web, macOS, Windows e Linux, tornando-a ideal para aplicações Dart full-stack. Ela aumenta a produtividade dos desenvolvedores, reduzindo o código boilerplate manual e garantindo consistência entre contratos de API e implementação.

Casos de uso

Gerando código cliente a partir de especificações OpenAPI
Automatizando a sincronização de contrato da API
Integrando o OpenAPI com projetos do Dart Frog
Simplificando o desenvolvimento full-stack em Dart
Habilitar chamadas de API com segurança de tipo em aplicativos Flutter

Principais recursos

Geração de especificação OpenAPI
Geração de código Dart para clientes
Integração sem falhas com o Dart Frog
Suporte multiplataforma
Interface de linha de comando para automação
Suporta contratos de API REST

Indicado para

desenvolvedores do Dart Frog
Equipes de Dart de stack completo
fluxos de trabalho de desenvolvimento com foco em API
Equipes usando especificações OpenAPI
Desenvolvedores procurando geração automática de cliente

Considerações

Requer especificação OpenAPI como entrada
Limitado ao ecossistema Dart Frog
Depende da qualidade do esquema OpenAPI externo
Pode exigir configuração para APIs complexas
Não adequado para projetos não-Dart Frog

README original

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

Nenuphar - Your OpenAPI generator CLI

Nenuphar is a CLI application to generate Swagger UI OpenAPI definition files for your Dart Frog Server.

https://github.com/PiotrFLEURY/nenuphar_cli/assets/25879276/1590e803-7888-4fa0-8555-2f29f2035bd1

Dart Frog

Dart Frog is a minimalistic backend framework for Dart.

Create a new Dart Frog project

To create a new Dart Frog backend project, run the following command:

dart pub global activate dart_frog_cli
dart_frog create <project name>

Nenuphar CLI

Installation

dart pub global activate nenuphar_cli

Initialize your project

First you need to initialize your project by running the following command in the root of your project:

nenuphar init

This will create new file public/index.html. This file will be served statically by your Dart Frog server to expose your Swagger UI documentation.

Generate openapi definition file

Nenuphar scans your Dart Frog project to generate an OpenAPI definition file. Each route will generate the CRUD operations documentation for the exposed resource.

First create a Dart Frog route:

dart_frog new route "/todos"

Then generate the OpenAPI definition file

nenuphar gen

The openapi specification will be written in the public/openapi.json file. This file is loaded by the public/index.html file to display the documentation.

Start your Dart Frog server

You're now ready to start your Dart Frog server

dart_frog dev

Visit http://localhost:8080/index.html to see your documentation.

open http://localhost:8080/index.html

Enjoy 🎉

Thanks for using Nenuphar!

Detailed documentation

Please visit https://piotrfleury.github.io/nenuphar_cli/ for detailed documentation.

Generated by the Very Good CLI 🤖

Buscar pacotes, repositórios e categorias de apps

Instalar pacote