Build a server-side RESTful API with Coldbox (Merapi)

Build a robust Coldbox REST API with this practical tutorial! Learn how to create and test a server-side API using the Coldbox framework, focusing on key components and best practices.

This course guides you through the process of developing a REST API with Coldbox, covering essential aspects from database setup to API documentation and testing. You'll gain hands-on experience with:

• Database Design & Migration: We'll establish a MySQL database schema for managing Countries, Currencies, Cities, and Airports. Utilize the Coldbox cfmigrations module to create and manage database tables and seed data. (Prerequisites: Familiarity with cfmigrations is helpful, but a refresher will be provided).
• Object-Relational Mapping (ORM): Explore a custom object-relational mapper approach, mapping entity class properties to database columns using an XML schema file. This alternative to Quick ORM provides a streamlined approach to data handling within Coldbox.
• Model & Services: Implement a clean and maintainable model using object inheritance with a BaseService component. This provides an abstraction layer for database queries (READ, DELETE, filtering) using the Super keyword, avoiding code duplication.
• Unit Testing with TestBox: Ensure the reliability of your Coldbox API by writing comprehensive unit tests using the TestBox module. Learn to test your model entities and service components.
• API Development: Build your REST API with well-defined API handlers (index, show, create, update, delete). Write integration tests using TestBox to guarantee handler functionality.
• API Documentation with cbSwagger: Generate interactive API documentation using the Coldbox cbSwagger module. This includes detailed descriptions of request bodies, parameters, and examples for each handler action. The generated documentation is easily exportable to tools like Postman and OpenAPI (Swagger).
• API Testing with Postman: Use Postman to simulate API calls and test your Coldbox REST API with real data. While detailed Postman tutorials are outside the scope of this course, you'll learn how to leverage it for practical testing.

Key takeaways:

• Develop a functional Coldbox REST API from start to finish.
• Understand best practices for Coldbox API development.
• Generate comprehensive API documentation for easy consumption.
• Implement robust unit and integration tests for API reliability.

Note: This course focuses on building the server-side API. Swagger Editor and Postman are used for documentation and testing, but detailed tutorials on these tools are not included. API security using Coldbox cbSecurity and JWT will not be covered. This course does not include building a JavaScript front-end to consume the API.