# @microloop/apispec-optimizer

> An OpenAPI specification optimizer for loopback 4

Latest version **0.3.11** (published 2023-07-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install @microloop/apispec-optimizer
pnpm add @microloop/apispec-optimizer
yarn add @microloop/apispec-optimizer
bun add @microloop/apispec-optimizer
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.11 |
| Published | 2023-07-27 |
| First published | 2023-03-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=16 |
| Dependencies | 2 |
| Unpacked size | 21.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | ty |
| Maintainers | towyuan |

## Links

- npm: https://www.npmjs.com/package/@microloop/apispec-optimizer
- npm.io page: https://npm.io/package/@microloop/apispec-optimizer

## Dependencies (2)

- [tslib](https://npm.io/package/tslib.md) ^2.6.1
- [inflection](https://npm.io/package/inflection.md) ^2.0.1

## Recent versions

- 0.3.11 (latest) — 2023-07-27
- 0.3.10 — 2023-07-18
- 0.3.9 — 2023-07-13
- 0.3.8 — 2023-06-28
- 0.3.7 — 2023-06-23
- 0.3.6 — 2023-06-23
- 0.3.5 — 2023-06-23
- 0.3.4 — 2023-06-21
- 0.3.3 — 2023-06-11
- 0.3.2 — 2023-06-07
- 0.3.1 — 2023-06-03
- 0.3.0 — 2023-05-22
- 0.2.9 — 2023-05-16
- 0.2.8 — 2023-05-14
- 0.2.7 — 2023-05-09
- … 7 more at https://npm.io/package/@microloop/apispec-optimizer/versions

## README

# @microloop/apispec-optimizer

> An OpenAPI specification optimizer designed for LoopBack 4 applications, which removes the `Controller` suffix from
> controller and tag names, and the prefix `...Controller.` from operationId.

## Installation

```sh
npm i @microloop/apispec-optimizer --save
```

## Usage

The component should be loaded in the constructor of your custom Application class.

Start by importing the component class:

```ts
import {ApiSpecOptimizerComponent} from '@microloop/apispec-optimizer';
```

In the constructor, add the component to your application:

```ts
this.component(ApiSpecOptimizerComponent);
```

This component provides a configuration for customizing the controller name and operationId of the OpenAPI spec.

```ts
import {CONTROLLER_NAME_KEY} from '@microloop/apispec-optimizer';

const apiSpecOptimizerOptions: ApiSpecOptimizerOptions = {
  customizeControllerName: (name, op, spec) => name + 'Api',
  customizeOperationId: (name, op, spec) => op[CONTROLLER_NAME_KEY] + '.' + name,
};
app.configure(ApiSpecOptimizerBindings.API_SPEC_OPTIMIZER).to(apiSpecOptimizerOptions);
```

## Optimization example

The OpenAPI spec generated by LoopBack applications is like:

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "LoopBack Application",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "/"
    }
  ],
  "paths": {
    "/test": {
      "get": {
        "x-controller-name": "TestController",
        "tags": ["TestController"],
        "operationId": "TestController.test",
        "responses": {
          "200": {
            "description": "test"
          }
        }
      }
    }
  }
}
```

After optimization with the configuration blow.

```ts
import {CONTROLLER_NAME_KEY} from '@microloop/apispec-optimizer';

const apiSpecOptimizerOptions: ApiSpecOptimizerOptions = {
  customizeControllerName: (name, op, spec) => name + 'Api',
  customizeOperationId: (name, op, spec) => op[CONTROLLER_NAME_KEY] + '.' + name,
};
app.configure(ApiSpecOptimizerBindings.API_SPEC_OPTIMIZER).to(apiSpecOptimizerOptions);
```

The OpenAPI spec is like:

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "LoopBack Application",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "/"
    }
  ],
  "paths": {
    "/test": {
      "get": {
        "x-controller-name": "TestApi",
        "tags": ["TestApi"],
        "operationId": "TestApi.test",
        "responses": {
          "200": {
            "description": "test"
          }
        }
      }
    }
  }
}
```

## Tests

Run `npm test` from the root folder.

## License

MIT

---
_Source: https://npm.io/package/@microloop/apispec-optimizer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
