Add SDK examples - Mintlify

If your users interact with your API through an SDK rather than direct network requests, use the x-codeSamples extension to add code samples to your OpenAPI document. Mintlify displays the samples on your OpenAPI pages. Add this property to any request method. It has the following schema.

lang

string

required

The language of the code sample.

label

string

The label for the sample. This is useful when providing multiple examples for a single endpoint.

source

string

required

The source code of the sample.

Here is an example of code samples for a plant tracking app, which has both a Bash CLI tool and a JavaScript SDK.

paths:
  /plants:
    get:
      # ...
      x-codeSamples:
        - lang: bash
          label: List all unwatered plants
          source: |
            planter list -u
        - lang: javascript
          label: List all unwatered plants
          source: |
            const planter = require('planter');
            planter.list({ unwatered: true });
        - lang: bash
          label: List all potted plants
          source: |
            planter list -p
        - lang: javascript
          label: List all potted plants
          source: |
            const planter = require('planter');
            planter.list({ potted: true });

Complex data types

Manage page visibility

⌘I