Bump
Search…
OpenAPI support
We both support OpenAPI 2 (Swagger) and 3, but sometimes with specificities.

Adding topics to your documentation

Creating a good API documentation requires to give users context and guides. As OpenAPI 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 yo 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!

Not (yet) supported properties

Partially supported: securitySchemes (V3) / securityDefinitions (V2)

We support OpenAPI securitySchemes property (securityDefinitions with openAPI v2) with these authentication type values:
  • http
  • apiKey
  • oauth2
  • openIdConnect
We do not support mutualTLS. To describe a mutualTLS authentication method, please use the x-topics property for now.

oneOf/anyOf

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