fureweb-com / nuxtswagger

Nuxt-ts-Swagger

NuxTSwagger

Nuxt-TS-Swagger plugin generator CLI

Installation

npm i -D nuxtswagger

Requirements

• Nuxt base project
• @nuxtjs/axios module

Basic Usage

in Nuxt project directory

nuxtswagger https://api.server.foo/swagger.json

in nuxt.config.js

module.exports = {
  plugins: [
    '~/plugins/api'
  ]
}

in component

export default {
  async asyncData ({ app: { $api } }) {
    return { foo: await $api.foo.get() }
  },
  data () { return { bar: undefined } },
  async mounted () { this.bar = await this.$api.bar.get() }
}

Options

nuxtswagger argument1 --option1=value1 --option2=value2

option	description	default	example
first argument	Swagger schema JSON path	(required)	http://.. or ./foo/swagger.json
src	same as first argument	first argument	same as above
plugins-dir	Nuxt plugins directory	plugins
plugin-name	Name for generated plugin	api
inject	Nuxt plugin inject key	{plugin-name}
type-path	Path for scheme type file	{plugins-dir}/{plugin-name}/{types.ts}	./types/swagger.d.ts
base-path	base path	/v1	/v2

Set options using package.json

{
  "scripts": {
    "swagger": "nuxtswagger"
  },
  "nuxtswagger": {
    "src": "https://api.server.foo/swagger.json",
    "pluginName": "foo"
  }
}

and npm run swagger or npx nuxtswagger

License

ISC License Copyright (c) 2020, Elevista