@loopback/docs/site/apidocs/openapi-spec-builder.componentsspecbuilder.withexample.md

Documentation files rendered at [https://loopback.io](https://loopback.io)

---
lang: en
title: 'API docs: openapi-spec-builder.componentsspecbuilder.withexample'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/openapi-spec-builder
permalink: /doc/en/lb4/apidocs.openapi-spec-builder.componentsspecbuilder.withexample.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/openapi-spec-builder](./openapi-spec-builder.md) &gt; [ComponentsSpecBuilder](./openapi-spec-builder.componentsspecbuilder.md) &gt; [withExample](./openapi-spec-builder.componentsspecbuilder.withexample.md)

## ComponentsSpecBuilder.withExample() method

Define a component example.

**Signature:**

```typescript
withExample(name: string, example: ExampleObject | ReferenceObject): this;
```

## Parameters

<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td markdown="1">

name


</td><td markdown="1">

string


</td><td markdown="1">

The name of the example


</td></tr>
<tr><td markdown="1">

example


</td><td markdown="1">

ExampleObject \| ReferenceObject


</td><td markdown="1">

Specification of the example


</td></tr>
</tbody></table>

**Returns:**

this