nenuphar_cli

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 🤖

---