npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

swagger-jsdoc-sync-webpack-plugin

v1.1.0

Published

Webpack plugin updating the swagger specification based on imported files

Downloads

164

Readme

swagger-jsdoc-sync-webpack-plugin

Webpack plugin updating the swagger specification based on imported files.

Installing / Getting started

  1. Install swagger-jsdoc-sync-webpack-plugin.
yarn add --dev swagger-jsdoc-sync-webpack-plugin
  1. Add the plugin in webpack configuration.
const SwaggerJsdocSyncWebpackPlugin = require('swagger-jsdoc-sync-webpack-plugin');
// webpack.config.js
module.exports = {
  plugins: [
    new SwaggerJsdocSyncWebpackPlugin({
      // Swagger specification metadata.
      swagger: {
        openapi: '3.0',
        info: {
          title: 'My API',
          version: require('./package.json').version,
          description: 'What my API does.',
        },
      },

      // Print the swagger.json readably.
      prettyJson: true,
    }),
  ],
};
  1. Use JSDoc to define your swagger definion in your code using @swagger tag. Do not forget to import every file that has swagger definitions.
/**
 * @swagger
 *
 * components:
 *   schemas:
 *     MyEntity:
 *       type: object
 *       required:
 *         - id
 *         - name
 *       properties:
 *         id:
 *           type: string
 *           description: Technical unique id.
 *         name:
 *           type: string
 *           description: Entity name.
 *         description:
 *           type: string
 *           description: Entity description.
 */

The created file will be swagger.json inside the output folder.

Options

  • swagger (Object) - Swagger definition (equivalent to swagger-jsdoc's swaggerDefinition option - see their documentation).
  • [prettyJson] (boolean) - If true, will pretty print the swagger.json file.
  • [filename='swagger.json'] (string) - Swagger specification output filename (relative to compilation output folder).
  • [emitWarningOnError=false] (boolean) - If true, will emit the bundle but not the swagger.json on swagger parsing error. Default behaviour is false, the bundle is not emitted either.

Tests

yarn test