You may not be authorized to see this content. Please contact Data Access Europe for more information.

Cancel Data Access Europe

You are not authorized to see this content.

Cancel Data Access Europe

The Web API Framework in DataFlex

26m 31s

Intermediate

In this course, we explore how to build structured and scalable REST APIs using DataFlex. The Web API Framework adds a powerful layer on top of the existing cWebHttpHandler, giving you the tools to handle HTTP requests in a simple, structured, and maintainable way. Whether you're exposing data to external systems, building mobile apps, or setting up internal services, this framework helps you do it efficiently and the right way. Let's get started.

Start course

Introduction to the Course.

Setting up the basics

In this lesson we will get your first REST API up and running. Using just a web API object and a JSON iterator, you'll learn how to set up the essentials to start handling requests and sending back responses. Let's get started!

Creating an endpoint

In this lesson we will walk you through building endpoints using the cRestDataset class and the DDO explorer. You will learn how to expose your inventory and vendor data, link related records, and test it all with Postman. Let's get your API working, step by step!

In this lesson we're diving into Swagger UI. Your new best friend for exploring and testing REST APIs directly in your browser. No more juggling between tools; Swagger UI lets you see all your API endpoints, try out requests, and check responses instantly. Powered by the OpenAPI spec and wrapped neatly into a DataFlex control, it's the easiest way to bring your APIs to life and speed up development. Let's get started!

In this lesson we're exploring routers! Routers help you organize your API endpoints by grouping them under one neat URL path. On their own, they might seem simple, just a way to tidy up your URLs. But when you combine routers with powerful features like authentication, they become a game changer. Let's dive in and see how to set one up step by step!

Implementing authentication

Securing your API is essential, and with DataFlex's powerful cWebApiAuthModifier, you can easily add robust login and security features. In this lesson we will walk you through the key steps to set up authentication, manage user sessions, and control access. All while keeping it flexible and smooth for your app and user.

Building a custom endpoint

In this lesson we will dive into building custom endpoints with DataFlex! We will show you how to create your own REST API routes that not only handle your HTTP logic but also plug straight into the OpenAPI spec, making your APIs easy to document, test, and share. Let's get started!

Course instructor

Niels de Boer

Software Engineer, Data Access Europe B.V.

Download on GitHub