@basketry/json-schema

JSON Schema

Basketry parser for JSON schema documents. This parser can be coupled with any Basketry generator to translate a JSON schema document into other artifacts including servers, clients, and human-readable documentation.

Quick Start

The following example converts a JSON schema into Typescript types:

• Save https://petstore.swagger.io/v2/swagger.json as petstore.json in the root of your project.
• Install packages: npm install -g basketry @basketry/json-schema @basketry/typescript
• Generate code: basketry --source petstore.json --parser @basketry/json-schema --generators @basketry/typescript --output src

When the last step is run, basketry will parse the source file (petstore.json) using the specified parser (@basketry/json-schema) and then run each specified generator (in this case only @basketry/typescript) writing the output folder (src).

For contributors:

Run this project

• Install packages: npm ci
• Build the code: npm run build
• Run it! npm start

Note that the lint script is run prior to build. Auto-fixable linting or formatting errors may be fixed by running npm run fix.

Create and run tests

• Add tests by creating files with the .test.ts suffix
• Run the tests: npm t
• Test coverage can be viewed at /coverage/lcov-report/index.html

Publish a new package version

• Ensure latest code is published on the main branch.
• Create the new version number with npm version {major|minor|patch}
• Push the branch and the version tag: git push origin main --follow-tags

The publish workflow will build and pack the new version then push the package to NPM. Note that publishing requires write access to the main branch.

Generated with generator-ts-console