Workshop - Building a REST API for the Modern Developer

In this hands-on workshop, you'll learn to build a modern REST API using a Behavior-driven approach with ColdBox MVC and other Ortus tools. You'll start by setting up and configuring your API with CommandBox, using environment variables and cfconfig. Your ColdBox RESTFul handler will deliver standard payloads secured by JWT authentication via cbSecurity. You'll validate data with cbValidation, document APIs with Swagger annotations, and test API calls using BDD integration tests.

Location

The exact location is coming soon, but it will be close to the strip.

What's Included

🍽️ Lunch is included

🎁 Ortus Swag and Surprises!

This workshop is designed for developers interested in building and securing a CFML/BoxLang REST API backend with JWT authentication. While familiarity with CommandBox and ColdBox is beneficial, it is not a requirement.

• Building a REST API using scaffolding templates and modules (cbSecurity, cbValidation, cbSwagger, cbSwagger-UI, and qb)
• Implementing best practices for routing, authentication, and documentation
• Securing API calls with JWT authentication
• Creating thorough API documentation
• Writing and running tests to ensure your API performs as expected

• Test your understanding of the workshop concepts with questions and exercises
• Reinforce your knowledge of Ortus Products.

• CommandBox
• Create and configure your environment file with variables
• Set up your .cfconfig file
• Install necessary modules
• Understand the box.json file and configure migrations
• Create the site using the REST-HMVC Template

• API Implementation

• Login, generate, and manage JWT
• CRUD operations (List, Show, Create, Update, Delete)
• Secure calls and validate inputs
• Document functions and test calls

• Workshop Coverage
• Setting up your site with CommandBox
• Creating a ColdBox REST API
• Creating and managing database tables via migrations
• Setting up database models and services
• Using API resourceful routes
• Implementing JWT authentication
• Previewing API responses with Postman
• API documentation and testing with Swagger UI Tooling

• Additional Topics (Time Permitting)
• Debugging with cbDebugger and the BoxLang Debugger

• Programming Knowledge: Basic understanding of API concepts and CFML. Familiarity with CommandBox and ColdBox is a plus.
• Hardware and Software: A laptop with CommandBox installed, a code editor (VS Code or preferred IDE), and a MySQL client.
• Database Setup: MySQL 8 installed locally or via Docker. We will provide a remote server as a backup.

• CommandBox: Download Here
• Postman: Download Here
• BoxLang IDE Dowload Here
• MySQL 8 (installed locally or in a Docker container with our docker-compose.yml)
• MySQL DB Client

You will leave with a fully functional REST API that is secure and well-documented. You'll understand:

• CommandBox basics for hosting your site
• Best practices for creating ColdBox REST APIs
• Securing your API with JWT authentication
• Using qb migrations for database management
• Validating API inputs
• Testing and documenting your APIs using Behavior-driven and Swagger tools

Host or Publisher Ortus Solutions, Corp