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 pub.dev. 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 {
@override
Future prepare() async {
logger.onRecord.listen((rec) => print("$rec ${rec.error ?? ""} ${rec.stackTrace ?? ""}"));
}
@override
Controller get entryPoint {
final router = Router();
router
.route("/example")
.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 API.is http://localhost:8888/example and if go there you will get the below response.





{"key":"value"}




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.





 router
.route("/user")
.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.





//user_controller.dart
import 'package:nplix/nplix.dart';

class UserController extends Controller{
@override
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.





router
.route("/user")
.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!"}
C:\Users\Pawan>




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 ...


Comments

  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.

    ReplyDelete

Post a Comment

Popular posts from this blog

Flutter Theme Creation, Programmatic Way

Flutter and Dart is an excellent combination for creating the mobile app with material design with nice GUI. Its lots of widget which help the developer for creating the app UI very fast with respect to the other language. You may face some problem in starting due to comm, curly brace and semicolon but after some time you will find the way how to work with these all stuff and it becomes very easy for you. But in this article, we are not going to discuss all these. In this article, we will handle a very interesting topic on how to create a custom theme or multiple themes and let's user decide which theme to use.



Create a flutter project



So let's create a flutter project by selecting the appropriate option from the File menu in android studio or Visual Code. If you are new to Flutter and Dart you can check out our recent post to get started Creating Cross-platform app using flutter.



Once your project is created you will get the default counter app and you try running the app in the…

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 sync completed.
Update the project build config …

Flutter State Management With Provider and ChangeNotifier

Flutter state management with provider library and why it's so important? There are lots of topics in flutter which are very important but out of those state management of your flutter application is the most important and little bit complicated as well. So in this article, I will try to explain how to use the provider package for managing the state of flutter and dart application and how to access the data down the hierarchy of the widget tree without recreating the whole UI.



Basic knowledge of the state management and data flow in the Flutter



Before starting the coding I would like to explain some basics about the Flutter application so that you can understand, why it's important to manage the state of your application in the correct way.



In Flutter, everything is a widget and whenever the state of your application changes the UI is recreated the UI with the new data. Let's list out the topic or problem that we are going to explore about state management.



Challenge of St…