Skip to main content

Dart REST API Server CRUD Application with aqueduct

Dart is the programming language created by Google and its very popular nowadays because it's providing the platform using which we can create a single code base for developing an application for Android, IOS and Web with the help of Flutter SDK. Today in this article we are going to explore how to create a REST API using the dart without Flutter.

Here in this part of the article, we will explore two things.

  • Expose Simple REST API using the DART programming language
  • Connect Dart with the Postgress using the Model

Create REST API in DART with aqueduct

So for creating the rest API using the dart we are going to use the aqueduct package available at This package provides lots of functionality which help us for creating the REST API server.

Let's start the creation of our REST API server. We required some setup before starting the coding.

  • Dart should be installed into your server or local environment
  • We required a Postgres database installed in your dev environment.

Activate the Aqueduct package globally

First of all, we need to activate the aqueduct package globally using the below command.

pub global activate aqueduct

Create the package with the default example Route

We need to create a dart package with the help of aqueduct command-line tool.

aqueduct create nplix

Above command will create a dart project which enables us further for creating the rest API. This will create some important file for our projects. We will let you know some information about some important files.

  • main.dart :- This file is inside the bin folder and its main file of our project which will run our project.
  • nplix.dart:- This file is very important files of the project which will export the important package which was used by the application.
  • channel.dart:- This is file where we are going define the route of our project.

Defining the new route and testing the default API

This file is the entry point of our server application and its content flowing lines of the code by default.

import 'nplix.dart';
class NplixChannel extends ApplicationChannel {
Future prepare() async {
logger.onRecord.listen((rec) => print("$rec ${rec.error ?? ""} ${rec.stackTrace ?? ""}"));
Controller get entryPoint {
final router = Router();
.linkFunction((request) async {
return Response.ok({"key": "value"});

return router;

If you look at the above code we have two override method prepare() and entryPoint(). The prepare method run before the entryPoint and its used to initialize the service of our rest API server application.

Let run the server and test the default route of our http://localhost:8888/example and if go there you will get the below response.


Perfect, Our rest API is working correctly. Let define our own AP.

Add route to our dart REST API server

For adding the new route to our app we just need to modify our entry point method and below lines of the code.

.linkFunction((request) async{
return Response.ok({"msg": "Welcome to Dart REST API!"});

If you look at the above code we have just added a new route with the user and link this route with the function which will respond with the msg. If you are working into visual code then just press the F5 and if it's already running then restart the application. Go the http://localhost:8888/user and you will get the response.

Link user route to Controller of our Dart REST API Server

For linking the route to the Controller we need to create a controller, so let's create our user controller. So let's create a folder inside of lib folder with the name of the controller and a class UserController.dart in that folder.

import 'package:nplix/nplix.dart';

class UserController extends Controller{
FutureOr<RequestOrResponse> handle(Request request) {
return Response.ok({"msg":"Welcome to Route Controller!"});


Perfect, We are ready to hook this controller with our user route. So let's modify the user root as given below in channel.dart file.

.link(() => UserController());

So what happing here when the user hit the http://localhost:8888/user URL our router will provide the control to the UserController class and UserController class will be responsible for responding to the request. This is a very simple controller that we have created there a lot more that we can do, it just the beginning of the controller. Let' test the application by re-running our server.

C:\Users\Pawan>curl http://localhost:8888/user
{"msg":"Welcome to Route Controller!"}

Perfect, Our controller is working fine. Let's move further and define the request type like get, post and more in the controller.

I don' want to make this boring so ending this article here in the next part of this article we will hook the route with the different type of the HTTP method and will connect our REST API with the database. To be continued ...


  1. I agree with a lot of the points you made in this article. If you are looking for the Web Search Api, then visit SERP House. I appreciate the work you have put into this and hope you continue writing on this subject.

  2. Hi to every single one, it’s truly a good for me to visit this web page, I love your content, they are very nice and it includes helpful Information. Check out our website API Development And Integration for more Metricoid Technology Solutions. related info! I am truly pleased to read this website posts which carries lots of helpful data, thanks for providing these kinds of statistics.

  3. Su artículo contiene palabras valiosas con un lenguaje igualmente sencillo. Una obligación de agradecimiento es compartir este mensaje de apoyo. desarrollador app

  4. Goodness, What an Amazing post. I really found this as well much teacher. It is the thing that I was searching for. I might need to propose that compassionate proceed to share such sort of info at thevicesolution

  5. Clearly, It is an engaging blog for us which you have provided here about web design abu dhabi This is a great resource to enhance knowledge about it. Thank you.


Post a Comment

Popular posts from this blog

Flutter How to Start Android Activity from Flutter View

Flutter and Dart is an excellent combination for creating the UI, but for accessing the platform-specific service we need to open platform-specific activity. So lets in this article we will explore how to start an android activity and access the service from Flutter View. Create a Project for this Android Activity Flutter View Demo Create a Project From File menu select the New Flutter Project Enter the project name Select the AndroidX support and click on next After the above, we step click on Finish We will have the following project structure created. Create the Second Activity in Android Just go to the android folder and open it in separate windows. We will have the following project structure. Create the Activity Just right-click on the Kotlin folder and create a blank activity from the menu. If you create the activity then you may be required to upgrade the Gradle and do some import. So Just click on update and wait for the project s

WordPress Android App with REST API And Retrofit

Retrofit is the library which converts your JSON data into Java object. In this tutorial, we will learn about how to implement the Retrofit to create a WordPress Mobile App. As we all know, WordPress is the one of the biggest CMS (Content Management System) of the world. Wordpress full fill the requirements for all most every type of the website. So, in this tutorial, I am going to learn how to create an Android App using the WordPress REST API and Retrofit. What is Retrofit? If you want to know about Retrofit, I would like to give you just a simple one-line explanation of the Retrofit. It is a library which converts your REST HTTP request to Java interface. We will learn how we can do all these stuff using some very simple steps. Further, you can check the Retrofit Library here . So, In this tutorial, we will use the Retrofit to retrieve all post and there except ( A short Description of Post) form a WordPress website. Prerequisite for using the Retrofit for WordPress Android App Ther

How to Read and Write JSON data in Kotlin with GSON

Kotlin is now official language for Android development and it is well supported in Android Studio. So here in this tutorial, we are going to learn about how to read and write JSON data in Kotlin using GSON. If you would like to learn the java version of this tutorial check out the last tutorial " How to Read and Write JSON data using GSON ". Introduction In this tutorial, we will write two methods. In the first method, we will create a JSON file and in second method we will read the file and print in a text box.  If you like to know more about the basic entity of JSON you can check out Basic JSON entity here . What is JSON? JSON stands for J ava S cript O bject N otation JSON is a lightweight data-interchange format It is "self-describing" and easy to understand JSON is language independent and can we used in any language JSON Syntax Rules Data is in name/value pairs Data is separated by commas Curly braces hold objects Square brackets hold