plugin-worma-docs weekly downloads statistics

plugin-worma-docs

Vite / Webpack plugin that turns an OpenAPI spec into a local handbook: method, path, request fields, response fields. No generated HTTP client.

Vite

import { defineConfig } from 'vite'
import { wormaDocs } from 'plugin-worma-docs'

export default defineConfig({
  plugins: [
    wormaDocs({
      swagger: 'https://petstore3.swagger.io/api/v3/openapi.json',
      output: 'src/api/aidocs',
      tags: ['pet', 'store'],
    }),
  ],
})

Several independent specs:

wormaDocs({
  swagger: [
    'https://api-a.example.com/swagger/v1/swagger.json',
    'https://api-b.example.com/swagger/v1/swagger.json',
  ],
  output: 'src/api/aidocs',
})

Different tags / folders per spec:

wormaDocs({
  swagger: [
    {
      swagger: 'https://api-a.example.com/swagger/v1/swagger.json',
      tags: ['CompanySupervision'],
      output:"src/api/data-center"
    },
    {
      swagger: 'https://api-b.example.com/swagger/v1/swagger.json',
      tags: ['Tender'],
      output: 'src/api/aidocs-tender',
    },
  ],
})

Same as worma apiFilter — one path, or a regex. Do not set tags at the same time:

wormaDocs({
  swagger: 'https://test2-gateway.hnyotech.com.cn/tenderalertapi/swagger/v1/swagger.json',
  output: 'src/api/aidocs',
  apiFilter: {
    scope: 'url',
    include: /\/api\/Alert\/FindAlert(Overview|Trend)$/,
  },
})

Several paths (union / OR):

wormaDocs({
  swagger: '.../swagger.json',
  apiFilter: [
    { scope: 'url', include: '/api/Alert/FindAlertOverview' },
    { scope: 'url', include: '/api/Alert/FindAlertTrend' },
  ],
})

Webpack 5

const { WormaDocsWebpackPlugin } = require('plugin-worma-docs/webpack')

module.exports = {
  plugins: [
    new WormaDocsWebpackPlugin({
      swagger: 'https://petstore3.swagger.io/api/v3/openapi.json',
      output: 'src/api/aidocs',
    }),
  ],
}

Options

Name	Default	Description
swagger	required	One URL, several URLs, or { swagger, tags?, output? } objects
output	src/api/aidocs	Handbook directory, relative to project root
tags	all tags	Shortcut for { scope: 'tag', include }. Mutually exclusive with apiFilter
apiFilter	all APIs	Same as wormajs apiFilter(). Mutually exclusive with tags
enable	true	Skip generation when false
force	false	Ignore worma cache and refetch the spec

Generation runs once on Vite buildStart and once on Webpack beforeRun / first watchRun. A failed fetch logs a warning and does not fail the build.