> For the complete documentation index, see [llms.txt](https://coldbox.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://coldbox.ortusbooks.com/ecosystem/api-documentation.md).

# API Documentation

Generate OpenAPI documentation for your ColdBox APIs automatically with cbswagger.

**cbswagger** generates OpenAPI (v3) documentation directly from your ColdBox routes and handler metadata — your API docs stay in sync with your code because they come from it.

```bash
box install cbswagger
```

📖 **Full documentation:** [ForgeBox](https://forgebox.io/view/cbSwagger) · [GitHub](https://github.com/coldbox-modules/cbSwagger)

## Quick Example

Install it, and your route table becomes an OpenAPI document:

```javascript
// config/Router.bx — routes you already have
route( "/api/users" ).toHandler( "users.index" )
route( "/api/users/:id" ).toHandler( "users.show" )
```

Then enrich handlers with metadata cbswagger reads:

{% tabs %}
{% tab title="BoxLang" %}

```javascript
/**
 * @route GET /api/users
 * @summary List all users
 * @tags Users
 * @response 200 {array} List of users
 */
function index( event, rc, prc ){
    event.renderData( type : "json", data : userService.list() )
}
```

{% endtab %}

{% tab title="CFML" %}

```javascript
/**
 * @route GET /api/users
 * @summary List all users
 * @tags Users
 * @response 200 {array} List of users
 */
function index( event, rc, prc ){
    event.renderData( type : "json", data : userService.list() )
}
```

{% endtab %}
{% endtabs %}

The generated spec is served from your app (by default at `/cbswagger`) and feeds Swagger UI, Postman, or any OpenAPI tooling.

## When to Use It

* Public APIs that need always-current documentation
* Teams generating client SDKs from an OpenAPI spec
* Contract testing against a live spec

## See Also

* [Resourceful Routes](/the-basics/routing/routing-dsl/resourceful-routes.md) — the route shapes cbswagger documents best
* [REST Handler](/digging-deeper/rest-handler.md) — building the APIs it documents


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://coldbox.ortusbooks.com/ecosystem/api-documentation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.