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-transform

v1.0.4

Published

A tool to generate API clients from Swagger/OpenAPI specs.

Downloads

68

Readme

swagger-transform

A tool to generate API clients from Swagger/OpenAPI specs.

Tips

  • Only support the json format of the Swagger/OpenAPI spec.
  • Partial content conversion may not be supported in some cases.

Installation

npm install swagger-transform

Usage

import { swaggerToType, swaggerToClass } from 'swagger-transform'

swaggerToType({
  entry: 'path/to/swagger.json',
  // or
  entry: 'https://example.com/swagger.json'
  // or
  entry: ['path/to/swagger1.json', 'path/to/swagger2.json'],
})

// or transform to class
swaggerToClass({
  entry: 'path/to/swagger.json',
})

Options

entry

  • Type: string | Array<string>
  • Required: true

The path to the Swagger/OpenAPI spec file or the URL to the Swagger/OpenAPI spec.

outDir

  • Type: string
  • Default: 'types'

The output directory of the generated type files.

index

  • Type: boolean
  • Default: false

Whether to generate an index file that exports all type files.

description

  • Type: string

Add a description at the top of each generated file.

typeMap

  • Type: object
  • Default: { integer: 'number' }

The mapping of the Swagger/OpenAPI types to TypeScript types.

api

  • Type: object | undefined

The configuration of the generated api file and type. If undefined, the api file will not be generated. The configuration is as follows:

  • api.fileName

    • Type: string
    • Default: 'apis'

    The file name of the generated api file

  • api.exportName

    • Type: string
    • Default: 'Apis'

    The export name of the generated api file

  • api.outDir

    • Type: string
    • Default: config.outDir

    The output directory of the generated api file

  • api.typeFileName

    • Type: string
    • Default: 'allApis'

    The file name of the generated api type file

  • api.typeName

    • Type: string
    • Default: 'AllApis'

    The export name of the generated api type file

  • api.definitionType

    • Type: 'type' | 'class'
    • Default: 'type'

    The type name of the generated api definition, When using the swaggerToClass function, you can configure

  • api.function

    • Type: boolean
    • Default: false

    Whether to generate the api function file, You need to improve the encapsulation of the request function yourself

  • api.functionFileName

    • Type: string
    • Default: 'repository'

    The file name of the generated api function file

  • api.functionImport

    • Type: string
    • Default: import request from \'./request\'

    The import statement of the generated api function file

  • api.reFunctionTemplate

    -Type: function

    A function that replace the api function

reParametersName

  • Type: function

A function that receives the parameter name and returns the new parameter name.

reDefinitionName

  • Type: function

A function that receives the definition name and returns the new definition name.

reDefinitionFileName

  • Type: function

A function that receives the definition name and returns the new definition file name.

reClassName

  • Type: function

A function that receives the class name and returns the new class name.