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

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

---
lang: en
title: 'API docs: openapi-spec-builder.componentsspecbuilder.withheader'
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.withheader.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; [withHeader](./openapi-spec-builder.componentsspecbuilder.withheader.md)

## ComponentsSpecBuilder.withHeader() method

Define a component header.

<b>Signature:</b>

```typescript
withHeader(name: string, header: HeaderObject | ReferenceObject): this;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  name | string | The name of the header |
|  header | HeaderObject \| ReferenceObject | Specification of the header |

<b>Returns:</b>

this