跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://www.mintlify.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

如果用户通过 SDK 而不是直接通过网络请求与你的 API 交互，你可以使用 x-codeSamples 扩展在 OpenAPI 文档中添加代码示例，并将其展示在 OpenAPI 页面中。 将此属性添加到任何请求方法。它具有以下模式。
​
lang
string
必填
代码示例所使用的编程语言。
​
label
string
示例的标签。在为同一端点提供多个示例时很有用。
​
source
string
必填
示例的源代码。
下面是一个植物追踪应用的代码示例，该应用同时提供 Bash CLI 工具和 JavaScript SDK。 
paths:
  /plants:
    get:
      # ...
      x-codeSamples:
        - lang: bash
          label: 列出所有未浇水的植物
          source: |
            planter list -u
        - lang: javascript
          label: 列出所有未浇水的植物
          source: |
            const planter = require('planter');
            planter.list({ unwatered: true });
        - lang: bash
          label: 列出所有盆栽植物
          source: |
            planter list -p
        - lang: javascript
          label: 列出所有盆栽植物
          source: |
            const planter = require('planter');
            planter.list({ potted: true });

相关主题

快速入门简介获取页面内容