Blog

Tip of the Week: ColdBox API Docs

Brad Wood October 17, 2012

Spread the word

Brad Wood

October 17, 2012

Spread the word


Share your thoughts

 

Hopefully you've seen and used the ColdBox docs, recipes, and video tutorials before.   What you may not know is there is an API reference that documents every class and method of the entire framework.  This can be very handy if you want to quickly look up all the arguments to the event.buildLink() method, or see what public methods can be called on a LogBox appender.  
 
The API docs are automatically generated based on component metadata (thanks to Mark Mandel's ColdDocs project) for every release of ColdBox that introduces API changes. The API Docs are nicely formatted much like Java Docs and even show what components are extended as well as inherited methods.  
 
You can download an HTML version of the API docs for any version of ColdBox, WireBox, CacheBox, LogBox, and MockBox here:
 
If you just want to search on the fly, check out our API Quick Docs which allow you to quickly search for any class or method.
 
Too lazy to leave your IDE to search the API docs?   Check out this wiki page that shows you how to install the syntax dictionaries into your favorite IDE to get intellisense as you type.
 

Add Your Comment

Recent Entries

BoxLang 1.17 Series Part 4 : WriteDump Enhanced!

BoxLang 1.17 Series Part 4 : WriteDump Enhanced!

You call writeDump() on an ORM entity or a very rich class graph . The browser locks up. Thirty seconds later you get a page with forty thousand rows on it, you scroll for a while, you give up, and you go edit your code to dump a sub-key instead. Or worse, you crash the server.

Luis Majano
Luis Majano
September 11, 2026
BoxLang AI 3.4 Blog Series Part 4 : Locking Down Prompt Injection

BoxLang AI 3.4 Blog Series Part 4 : Locking Down Prompt Injection

LLM applications face a class of attack traditional input validation was never built for: prompt injection. An attacker embeds instructions in user input, a retrieved document, a web page your tool fetched, or an MCP result, trying to override your system prompt, exfiltrate data, or hijack a tool call. BoxLang AI 3.4.0 ships four layered, configurable defenses against exactly this, plus one more that's on unconditionally.

Luis Majano
Luis Majano
September 11, 2026