NuxTSwagger
Nuxt-TS-Swagger plugin generator CLI
Installation
npm i -D nuxtswagger
Requirements
-
Nuxt
base project
Basic Usage
in Nuxt project directory
npx nuxtswagger https://api.server.foo/swagger.json
in script code
import { api } from '~/lib/api'
await api().foo.post()
Path param mode
see form
option
/* default (1.1.0+) */
api().foo.bar(1).get(2)
api().foo.bar.get()
/* underscore */
api().foo._bar.get(1, 2)
api().foo.bar.get()
Options
options priority : command line > nuxt.config
> package.json
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 |
skip-header |
Ignore parameter in header | false |
true |
form |
Path param interface mode | (undefined) | underscore |
package.json
Set options using {
"nuxtswagger": {
"pluginName": "foo",
"src": "https://api.server.foo/swagger.json"
}
}
nuxt.config
Set options using v1.2+
export default defineNuxtConfig({
nuxtswagger: [
{ pluginName: 'foo', src: 'https://api.server.foo/swagger.json' },
{ pluginName: 'bar', src: 'https://api.server.bar/swagger.json' },
],
runtimeConfig: {
public: {
nuxtswagger: {
pluginName: 'foo',
// AxiosRequestConfig?
axiosConfig: { baseURL: 'https://api-stage.server.foo' }
},
},
},
})
tsconfig.json
{
"compilerOptions": {
"types": ["nuxtswagger/types"]
}
}
and npm run swagger
or npx nuxtswagger
License
ISC License Copyright (c) 2020, Elevista