Examples
A code sample or line of text that shows the specific structure of a request/response, input/output, or value for UI/API elements
:::note
If you are unsure about when to categorize something as an example or tutorial, remember:
Examples are a component attribute and are typically a snippet of code a user might copy and paste to run a task. Examples should not have multiple steps. A tutorial might contain an example, but an example will not contain a tutorial.
Tutorials are a content type, typically longer form, and contain multiple steps to help users connect products to real-world scenarios.
:::
Used in
Structure
Context
Explain what the code sample does in a short sentence.
Code blocks or snippets
These could include:
- Example requests and responses
- Example inputs and outputs
- Field values for UI and/or API
Additional information
Requests/feedback
这篇文档对你有帮助吗？
谢谢你的反馈！