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

@acrontum/oas-codegen-parser

v1.2.0

Published

OpenAPI schema parser / mapper for codegen tools

Downloads

83

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

acrontum_sanchezacrontum_sanchezacrontum_revahacrontum_revahacrontum_brodeacrontum_brodeacrontum_eickenacrontum_eickenacrontum_knoblachacrontum_knoblachacr-p-mcgowanacr-p-mcgowancarmichael.johncarmichael.john

Keywords

Readme

Table of Contents generated with DocToc

Typegen

OpenAPI schema parser / mapper for codegen tools. Walks an opanpi v3 schema and produces an intermediate schema for consumption by generators (not included).

Early alhpa - docs subject to change.

Install

Install from src (pre-release)

npm install
npm run build
npm pack
# from consumer project: npm i -D /path/to/oas-typegen-0.0.1.tgz

post-release:

npm install --save-dev @acrontum/oas-typegen

Quickstart

By default, oas-typegen will dump the parsed spec to stdout which can then be used for codegen:

npx oas-typegen api.json >typegen.json

Note that it will not convert yaml to json, and only accepts schema 3.x, and does not validate the schema either. If you want to convert to json or validate / version upgrade, you can use any number of existing tools to do so (eg swagger editor).

Examples

npm i
npm run build -- -p tsconfig.examples.json
node ./dist/examples/generators/node-typescript.js ./examples/inputs/spec.json ./outputs/typings/node-typescript/
node ./dist/examples/generators/class-validator.js ./examples/inputs/spec.json ./outputs/typings/class-validator/