@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
188 lines (87 loc) • 3.04 kB
Markdown
---
lang: en
title: 'API docs: openapi-v3.oasenhancerservice'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/openapi-v3
permalink: /doc/en/lb4/apidocs.openapi-v3.oasenhancerservice.html
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/openapi-v3](./openapi-v3.md) > [OASEnhancerService](./openapi-v3.oasenhancerservice.md)
## OASEnhancerService class
An extension point for OpenAPI Spec enhancement This service is used for enhancing an OpenAPI spec by loading and applying one or more registered enhancers.
A typical use of it would be generating the OpenAPI spec for the endpoints on a server in the `@loopback/rest` module.
**Signature:**
```typescript
export declare class OASEnhancerService
```
## Constructors
<table><thead><tr><th>
Constructor
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[(constructor)(getEnhancers, options)](./openapi-v3.oasenhancerservice._constructor_.md)
</td><td markdown="1">
</td><td markdown="1">
Constructs a new instance of the `OASEnhancerService` class
</td></tr>
</tbody></table>
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[options?](./openapi-v3.oasenhancerservice.options.md)
</td><td markdown="1">
`readonly`
</td><td markdown="1">
[OASEnhancerServiceOptions](./openapi-v3.oasenhancerserviceoptions.md) \| undefined
</td><td markdown="1">
_(Optional)_ An extension point should be able to receive its options via dependency injection.
</td></tr>
<tr><td markdown="1">
[spec](./openapi-v3.oasenhancerservice.spec.md)
</td><td markdown="1">
</td><td markdown="1">
[OpenApiSpec](./openapi-v3.openapispec.md)
</td><td markdown="1">
Getter for `_spec`
</td></tr>
</tbody></table>
## Methods
<table><thead><tr><th>
Method
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[applyAllEnhancers(options)](./openapi-v3.oasenhancerservice.applyallenhancers.md)
</td><td markdown="1">
</td><td markdown="1">
Generate OpenAPI spec by applying ALL registered enhancers TBD: load enhancers by group names
</td></tr>
<tr><td markdown="1">
[applyEnhancerByName(name)](./openapi-v3.oasenhancerservice.applyenhancerbyname.md)
</td><td markdown="1">
</td><td markdown="1">
Apply a given enhancer's merge function. Return the latest \_spec.
</td></tr>
<tr><td markdown="1">
[getEnhancerByName(name)](./openapi-v3.oasenhancerservice.getenhancerbyname.md)
</td><td markdown="1">
</td><td markdown="1">
Find an enhancer by its name
</td></tr>
</tbody></table>