mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify-development[bot]
ad11bc265d
* Fix Vale style warnings: passive voice and punctuation - Convert passive voice to active voice in multiple component docs - Fix quotation mark punctuation in navigation.mdx - Update heading text to use correct casing Style-only changes that don't affect content meaning. Generated-By: mintlify-agent * Apply suggestion from @ethanpalm --------- Co-authored-by: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
51 lines
1.5 KiB
Plaintext
51 lines
1.5 KiB
Plaintext
---
|
|
title: "Add SDK examples"
|
|
description: "Display SDK code samples in your API documentation."
|
|
keywords: ["x-codeSamples", "SDK examples"]
|
|
---
|
|
|
|
If your users interact with your API using an SDK rather than directly through a network request, you can use the `x-codeSamples` extension to add code samples to your OpenAPI document and display them in your OpenAPI pages.
|
|
|
|
Add this property to any request method. It has the following schema.
|
|
|
|
<ParamField body="lang" type="string" required>
|
|
The language of the code sample.
|
|
</ParamField>
|
|
|
|
<ParamField body="label" type="string">
|
|
The label for the sample. This is useful when providing multiple examples for a single endpoint.
|
|
</ParamField>
|
|
|
|
<ParamField body="source" type="string" required>
|
|
The source code of the sample.
|
|
</ParamField>
|
|
|
|
Here is an example of code samples for a plant tracking app, which has both a Bash CLI tool and a JavaScript SDK.
|
|
|
|
```yaml
|
|
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 });
|
|
```
|
|
|