パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v0.2.2

nenuphar_cli

Very Good CLI によって作成された、Dart Frog 向けの OpenAPI 生成 CLI。

AndroidiOSWebmacOSWindowsLinux
30日間ダウンロード
61
いいね数
29
Pub ポイント
130

パッケージをインストール

flutter pub add nenuphar_cli

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

Nenuphar CLI は、API 定義から OpenAPI の仕様と Dart コードを生成するためのコマンドラインツールであり、Dart Frog との統合を目的としています。Very Good CLI によって開発され、OpenAPI スキーマに基づいて型安全なクライアントコードを自動生成することで、バックエンドからフロントエンドへの開発を簡素化します。Android、iOS、Web、macOS、Windows、Linux など複数のプラットフォームをサポートしており、フルスタックの Dart アプリケーションに最適です。手動でのボイラープレートコードの削減と API コントラクトと実装の整合性の確保により、開発者の生産性を向上させます。

用途

  • OpenAPI仕様からクライアントコードを生成する
  • API契約の同期を自動化する
  • Dart Frog プロジェクトへの OpenAPI の統合
  • フルスタックのDart開発を最適化する
  • Flutterアプリで型安全なAPI呼び出しを有効にする

主な機能

  • OpenAPI仕様の生成
  • クライアント用のDartコード生成
  • シームレスなDart Frog統合
  • マルチプラットフォーム対応
  • 自動化用のコマンドラインインターフェース
  • REST API コントラクトをサポートしています

適している対象

  • Dart Frog 開発者
  • フルスタックDartチーム
  • APIファースト開発ワークフロー
  • OpenAPI仕様を使用するチーム
  • 自動クライアント生成を求める開発者

注意事項

  • 入力としてOpenAPI仕様が必要です
  • Dart Frogエコシステムに限定
  • 外部のOpenAPIスキーマの品質に依存する
  • 複雑なAPIには構成が必要になる場合があります
  • Dart Frog以外のプロジェクトには適していません

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Nenuphar - Your OpenAPI generator CLI

nenuphar logo generated using Microsoft Designer

style: very good analysis License: MIT

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 🤖


カテゴリー

依存関係

依存関係一覧 6 件

ソースリポジトリ

このパッケージを使用しているプロジェクト

データはまだありません。