搜尋套件、儲存庫與 APP 分類

套件詳情v1.1.0+13

dchisel

一個用於建立REST API的簡單Dart Web框架。DChisel支援自訂中介軟體以及MySQL與PostgreSQL ORM。

近 30 天下載
11
喜歡數
46
Pub 分數
80

安裝套件

flutter pub add dchisel

套件介紹

根據套件公開資料產生的選型評估,僅供參考。

DChisel 是一個輕量級的 Dart Web 框架,專為建立 REST APIs 而設計。它提供對 MySQL 和 PostgreSQL ORM 的內建支援,實現無縫的資料庫互動。此框架允許開發者實作自訂中間件來處理請求與路由邏輯。著重於簡潔性與效能,DChisel 非常適合需要結構化 API 開發與資料庫整合的後端服務。它運行在 Dart 上,適用於針對 Web 環境的伺服器端應用程式。

適用情境

  • 建構 RESTful API
  • 基於資料庫的後端服務
  • 基於中介軟體的請求處理
  • 伺服器端 Dart 應用程式
  • 與 MySQL/PostgreSQL 集成的 API

主要特色

  • 自定義中間件支援
  • MySQL 與 PostgreSQL ORM
  • 輕量且快速
  • 簡單的 REST API 結構
  • Dart 原生的伺服器端執行

適合對象

  • 使用 Dart 的後端開發人員
  • 構建以 API 為首的應用程式團隊
  • 需要資料庫 ORM 的專案
  • Web 伺服器,開銷極小
  • 尋求簡單伺服器框架的開發者

使用建議

  • 有限的平台支援(不支援行動裝置或桌面端)
  • 無內建驗證
  • 複雜設定需要手動設定
  • 不適合用於UI密集型應用
  • 依賴社群維護

原始 README

以下為關聯原始碼儲存庫的 README 原文快照,最新內容請造訪原始碼儲存庫。

Dchisel Logo

DChisel Dart Framework

DChisel is simple Dart Framework for creating REST API

pub package

English Documentation Indonesia Documentation

Features

  • Custom host server and port
  • GET, POST, PUT, DELETE, PATCH Routes
  • ORM CRUD to PostgreSQL
  • ORM CRUD to MySQL
  • Global Middleware
  • Specific Route Middleware
  • Auth
  • Base Response Ok & Forbidden
  • Header CORS
  • Base64 decode to File
  • Hotreload

Usage

To add the dchisel to your Dart application read the install instructions.

Host Server

Default host is "localhost" and port 8000

import 'package:dchisel/dchisel.dart';

Future<void> main(List<String> arguments) async {
  DRoute route() {
    var droute = DRoute();
    droute.get('/', (Request req) async => resOk("Hello, DChisel"));
    return droute;
  }
  DChisel().serve(getroutes: route());
}

If you want to change the host to 0.0.0.0 and port to 5555 you can use :

 DChisel().serve(getroutes: route(), serverHost: '0.0.0.0', serverPort: 5555);
GET Route
droute.get('/hello', (Request request) {
    return 'Hello, World';
});

GET with param you can use :

droute.get('/getparam/<name>', (Request request, String name) {
    return 'Hello, $name';
});
POST Route
droute.post('/hello', (Request request) async {
    return 'Hello, World';
});

If you want to get Body value from your POST request, use :

var body = await request.body.asJson;

If you want to get Header value from your POST request, use :

var headers = await request.headers;
PUT Route
droute.put('/hello/<name>', (Request request, String name) async {
  return 'Hello, $name';
});

PUT also can get Header and Body request

var headers = await request.headers;
var body = await request.body.asJson;
DELETE Route
droute.delete('/hello/<name>', (Request request, String name) async {
  return 'Hello, $name';
});

Dchisel ORM

For now, DChisel only support PostgreSQL and MySQL

DB Config
DChiselDB().configDB('dialect', // DIALECT DATABASE, IF YOU USE POSTGRESQL CHANGE 'dialect' to 'postgre', IF YOU USE MYSQL CHANGE 'dialect' to 'mysql'
    host: 'your_host',
    db: 'your_db_name',
    port: your_port, //integer
    username: 'your_db_username',
    password: 'your_db_password');
Get All Data
DChiselDB().getAll('your_table_name');
Get Data With Custom Column and Filter
DChiselDB().getOption('your_table_name', 
    column: 'your_column1,your_column2', 
    where: ['your_column_name', 'your_filter_value']);

If you want filter contains, just add % into your filter value, example :

'%your_filter_value%'
Create Data
DChiselDB().create('users', data: {
    'your_column_name': 'your_value'
});
Update Data
DChiselDB().update('users', data: {
    'your_column_name': 'your_value'
}, where: ['your_filter_column_name', 'your_filter_value']);
Delete Data
DChiselDB().deleteAll('your_table_name');
Delete Data Custom Filter
DChiselDB().deleteOption('your_table_name', where: ['your_filter_column_name', 'your_filter_value']);

Issues

Please file any issues, bugs or feature requests as an issue on our GitHub page. Commercial support is available, you can contact us at <alphacsoft@gmail.com>.

Want to contribute

If you would like to contribute to the plugin (e.g. by improving the documentation, solving a bug or adding a cool new feature), please carefully review our contribution guide and send us your pull request.

Author

This dchisel framework for Dart is developed by Alphacsoft.

所屬分類

依賴

依賴清單 14 項

原始碼儲存庫

使用此套件的專案

暫無相關資料。