Category Selected:

rest

Blog

swagger SDK and cbSwagger v2 Released!

Luis Majano |  September 03, 2019

We are very excited to finally update our swagger modules to version 2: swagger-sdk, cbSwagger. This major version has tons of new features and improvements when documenting ColdBox APIs. However, the biggest features are that we now support the latest Open API Spec => v3.0.2 and we can export your documentation in either JSON or YAML. Check out the release notes below to see all the great new improvements.

Read More


CFSummit2017 - ColdBox Hierarchical MVC - Transform Your Monolith

Luis Majano |  November 20, 2017

Here are our slides from our ColdBox Hierarchical MVC presentation at this year's Adobe ColdFusion Summit. You can also find the source code for our demo here: https://github.com/lmajano/hmvc-presso-demo or you can install it via CommandBox: box install lmajano/hmvc-presso-demo.

Read More

CFObjective 2017 - 3 WAYS TO TEST YOUR COLDFUSION API - Gavin Pickin

Gavin Pickin |  July 24, 2017

Most projects in CF now involve creating some type of consumable CFC Endpoint or API Service... do you Unit test your API, do you use Integration Tests on your API? How many ways do you test your API? Not all tests are created equal.

We build our CFCs and CF API to be consumed with CF Apps, Mobile Apps, Javascript apps and devices we haven’t even thought about yet. To be smart developers we need to be able to test our CFC endpoints, and the code that uses those endpoints.

Read More

ColdBox Relax v3.0 Released

Jon Clausen |  April 11, 2017

ColdBox Relax

Coldbox Relax LogoColdBox Relax Moldule v3.0 has been officially released, which includes native support for the OpenAPI/Swagger specification, in addition to a variety of feature upgrades and enhancements.

Version 3.0 makes the OpenAPI/Swagger specification the default documentation format for describing your APIs, while deprecating the Relax programmatic DSL ( scheduled EOL is v4.0 ). In addition, the release includes a complete overhaul of the user interface and Relax API Test Tool, to provide users with a seamless experience for documenting, viewing, testing and exporting in a variety of formats.

Read More

Making a live edit contact list with Coldbox REST & Vue.js

Scott Steinbeck |  March 28, 2016

Today we will be making a contact database that you can quickly and easily manage using ColdBox and Vue.js. We will be using bootstrap in our project to make it the UI look a little better but it is completely optional if you want to use this in your own project.

For this project I will be using CommandBox to generate all my files.

TL;DR: View the repo here

Lets Begin.

Step 1: You can skip this step if you already have a project set up. 

From CommandBox run:

coldbox create app name=CBVue skeleton=rest --installColdBox

This will give us a minimal project with a handlers\BaseHandler.cfc (needed to make our life easy when creating a REST API) and an handlers\Echo.cfc which is an example usage to get you started.

Now that we have our project started we need to tweak a few things.

First, since this is a template that is expecting to be setup for REST only, the Echo.cfc is set to be the default entry point. Since we want to create a view that accesses a REST API we need to point that to a view.

Read More

REST 2016 - Testing your API with Jasmine

Gavin Pickin |  March 25, 2016

Are you writing APIs? Going to start writing APIs? Now is the time to start testing. Sounds familiar, it should, because you’ll be hearing that a LOT. Do it early, and often, and reap the benefits as the project grows. Whether you are using CFML or not, TestBox is a great way to test your APIs, like I showed you in a previous blog post. Today, we’ll look at Jasmine, and see how you can test your APIs with Javascript… and a couple of “gotchas” I ran into as well.

Read More

REST2016 - Route Conditions

Luis Majano |  March 23, 2016

Sometimes when you define an incoming API route, you want it to match certain environment or aspect conditions. The addRoute() has an argument called condition, which can be a closure or UDF pointer that must return a boolean and receives the incoming requestString. You can then decide if the route should execute or just be ignored.

So if a route matches via the pattern, then this closu...

Read More

Building Ionic Apps with ColdBox REST

Scott Steinbeck |  March 22, 2016

Are you ready to enter the exciting world of app building? In today's world, 60% of people are viewing your website on a mobile phone most sites are hard to navigate.  People constantly ha...

Read More

REST2016 - Testing your API with TestBox

Gavin Pickin |  March 18, 2016

Are you writing APIs? Going to start writing APIs? Now is the time to start testing. Do it early, and often, and reap the benefits as the project grows. TestBox, the defacto CFML test suite, can help your test your API, whether it’s CFML or not.

I will assume you have the basic TextBox installation setup.
 

Read More

REST2016 - Route Responses

Luis Majano |  March 14, 2016

You can route responses inline with ColdBox via the addRoute() function globally in your main routes.cfm template or within any Module as well. This will allow you to build simple response functions or even mock out or stub a RESTFul service very easily. The paremeters you will use for response routing will be: response, statusCode and statusText.

The response argument can be a string or a closure or UDF pointer. T...

Read More