Search packages, repositories and app categories

Package detailsv1.1.0+13

dchisel

A simple dart web framework for create REST API. DChisel support Custom Middleware and Mysql & PostgreSQL ORM.

30-day downloads
11
Likes
46
Pub points
80

Install package

flutter pub add dchisel

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

DChisel is a lightweight Dart web framework designed for building REST APIs. It provides built-in support for MySQL and PostgreSQL ORM, enabling seamless database interactions. The framework allows developers to implement custom middleware for request handling and routing logic. With a focus on simplicity and performance, DChisel is ideal for backend services that require structured API development with database integration. It runs on Dart and is suitable for server-side applications targeting web environments.

Use cases

  • Building RESTful APIs
  • Database-driven backend services
  • Middleware-based request processing
  • Server-side Dart applications
  • APIs with MySQL/PostgreSQL integration

Key features

  • Custom middleware support
  • MySQL and PostgreSQL ORM
  • Lightweight and fast
  • Simple REST API structure
  • Dart-native server-side execution

Suitable for

  • Backend developers using Dart
  • Teams building API-first applications
  • Projects requiring database ORM
  • Web servers with minimal overhead
  • Developers seeking simple server frameworks

Considerations

  • Limited platform support (no mobile or desktop)
  • No built-in authentication
  • Requires manual configuration for complex setups
  • Not suited for UI-heavy applications
  • Dependent on community maintenance

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

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.

Categories

Dependencies

Dependency list 14 items

Source repository

Projects using this package

No data available yet.