@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
122 lines (59 loc) • 2.2 kB
Markdown
---
lang: en
title: 'API docs: openapi-spec-builder.openapispecbuilder'
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.openapispecbuilder.html
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/openapi-spec-builder](./openapi-spec-builder.md) > [OpenApiSpecBuilder](./openapi-spec-builder.openapispecbuilder.md)
## OpenApiSpecBuilder class
A builder for creating OpenApiSpec documents.
**Signature:**
```typescript
export declare class OpenApiSpecBuilder extends BuilderBase<OpenAPIObject>
```
**Extends:** [BuilderBase](./openapi-spec-builder.builderbase.md)<!-- --><OpenAPIObject>
## Constructors
<table><thead><tr><th>
Constructor
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[(constructor)()](./openapi-spec-builder.openapispecbuilder._constructor_.md)
</td><td markdown="1">
</td><td markdown="1">
Constructs a new instance of the `OpenApiSpecBuilder` class
</td></tr>
</tbody></table>
## Methods
<table><thead><tr><th>
Method
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[withComponents(spec)](./openapi-spec-builder.openapispecbuilder.withcomponents.md)
</td><td markdown="1">
</td><td markdown="1">
Define a new ComponentsObject.
</td></tr>
<tr><td markdown="1">
[withOperation(verb, path, spec)](./openapi-spec-builder.openapispecbuilder.withoperation.md)
</td><td markdown="1">
</td><td markdown="1">
Define a new OperationObject at the given path and verb (method).
</td></tr>
<tr><td markdown="1">
[withOperationReturningString(verb, path, operationName)](./openapi-spec-builder.openapispecbuilder.withoperationreturningstring.md)
</td><td markdown="1">
</td><td markdown="1">
Define a new operation that returns a string response.
</td></tr>
</tbody></table>