# @woldtwerk/nuxt-openapi

> OpenApi UI using swagger or redoc

Latest version **0.0.3** (published 2023-08-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install @woldtwerk/nuxt-openapi
pnpm add @woldtwerk/nuxt-openapi
yarn add @woldtwerk/nuxt-openapi
bun add @woldtwerk/nuxt-openapi
```

## Health

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

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

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2023-08-29 |
| First published | 2023-06-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 13.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | woldtwerk |

## Links

- npm: https://www.npmjs.com/package/@woldtwerk/nuxt-openapi
- Repository: https://github.com/woldtwerk/nuxt-openapi
- Homepage: https://github.com/woldtwerk/nuxt-openapi#readme
- Issues: https://github.com/woldtwerk/nuxt-openapi/issues
- npm.io page: https://npm.io/package/@woldtwerk/nuxt-openapi

## Dependencies (5)

- [h3](https://npm.io/package/h3.md) ^1.8.1
- [ufo](https://npm.io/package/ufo.md) ^1.3.0
- [@nuxt/kit](https://npm.io/package/@nuxt/kit.md) ^3.7.0
- [colorette](https://npm.io/package/colorette.md) ^2.0.20
- [@nuxt/devtools-kit](https://npm.io/package/@nuxt/devtools-kit.md) ^0.8.2

## Recent versions

- 0.0.3 (latest) — 2023-08-29
- 0.0.2 — 2023-06-06

## README

# Nuxt OpenApi

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]

This module adds a Tab to nuxt devtools. It shows your OpenApi spec.

![nuxt-openapi](./assets/nuxt-openapi.webp)

- [✨  Release Notes](/CHANGELOG.md)
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/@woldtwerk/nuxt-openapi?file=playground%2Fapp.vue) -->
<!-- - [📖 &nbsp;Documentation](https://example.com) -->

## Features

<!-- Highlight some of the features your module provide here -->
- ⛰ &nbsp;SwaggerUI or Redoc
- 🚠 &nbsp;Autoconfig for nuxt-drupal

## Quick Setup

1. Add `@woldtwerk/nuxt-openapi` dependency to your project

```bash
# Using pnpm
pnpm add -D @woldtwerk/nuxt-openapi

# Using yarn
yarn add --dev @woldtwerk/nuxt-openapi

# Using npm
npm install --save-dev @woldtwerk/nuxt-openapi
```

2. Add `@woldtwerk/nuxt-openapi` to the `modules` section of `nuxt.config.ts`

```js
export default defineNuxtConfig({
  modules: [
    '@woldtwerk/nuxt-openapi'
  ]
})
```

3. Add your openapi url.
```js
export default defineNuxtConfig({
  openapi: {
    url: 'https://myapi'
  },
})
```

That's it! You can now use Nuxt OpenApi in your Nuxt app ✨

## Drupal
If you use @woldtwerk/nuxt-drupal no configuration is needed.
In your drupal you need to install [openapi](https://www.drupal.org/project/openapi) and [openapi_ui](https://www.drupal.org/project/openapi_ui).

## Development

```bash
# Install dependencies
pnpm install

# Generate type stubs
pnpm run dev:prepare

# Develop with the playground
pnpm run dev

# Build the playground
pnpm run dev:build

# Run ESLint
pnpm run lint

# Run Vitest
pnpm run test
pnpm run test:watch

# Release new version
pnpm run release
```

<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/@woldtwerk/nuxt-openapi/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@woldtwerk/nuxt-openapi

[npm-downloads-src]: https://img.shields.io/npm/dm/@woldtwerk/nuxt-openapi.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/@woldtwerk/nuxt-openapi

[license-src]: https://img.shields.io/npm/l/@woldtwerk/nuxt-openapi.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/@woldtwerk/nuxt-openapi

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
[nuxt-href]: https://nuxt.com

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