Bump
Search…
AsyncAPI support
AsyncAPI support is currently in beta test. We are only supporting AsyncAPI 2.0, for JSON event driven APIs.

Adding topics to your documentation

Creating a good API documentation requires to give users context and guides. As AsyncAPI doesn't permit to add generic content, we have created a custom property. Setting the x-topics property at the root of your documentation specification will let you add some content sections at the beginning of your documentation.
Each topic can have the following properties:
Property
Description
title
Topic title as it will appear in the navigation bar and in the content section.
content
The topic content. Markdown is fully supported here.
example
Will appear in the examples section, if activated. Markdown is fully supported here.
Example:
1
x-topics:
2
- title: Getting started
3
content: Before using the API you need to get an API key by sending us an email.
4
- title: Authentication
5
content: Send the `X-API-KEY` header with all your requests.
6
example: |
7
```
8
$ curl \
9
-X POST https://api.example.com/endpoint/ \
10
-H "X-API-KEY: XXXXXX" \
11
```
Copied!

Current support state

Event driven APIs world is more complex than REST APIs one: there are more protocols, more tools, more different architectures. As a consequence, AsyncAPI is more complex that OpenAPI to support. We wanted to open our beta fast, so we have chosen to release it with minimal features.

Currently supported

Bump is able to extract:
  • root properties (AsyncAPI Object)
  • channels (with automatic grouping according to channel name or tag grouping)
  • operations (subscribe and publish)
  • messages (payload and headers), with examples.
  • bindings (server, operation and message).

Partially supported: message object payload

Message#payload could be of any type according to the specification, but we only support SchemaObject type.

Partially supported: server security and securitySchemes

We support AsyncAPI securitySchemes property with these authentication types:
  • http
  • apiKey
  • httpApiKey
  • oauth2
  • openIdConnect
We do not support X509, symmetricEncryption, asymmetricEncryption, plain, scramSha256, scramSha512 nor gssapi. To describe these authentication types, please use our custom x-topics property for now.

Unsupported: anyOf/oneOf

We do not support anyOf statement, and won't in a near future. Introducing anyOf would imply to support kind of a "or" statement, which is particularly complex to handle and restitute from an UI point of view.
Last modified 2mo ago