Skip to content

Repository files navigation

async api valdator and joiner

A nodejs server providing an rest api (including swagger ui for humans).

This is a tool with 2 puposes.

Join sync api files

As $ref to non json compatible files (json or yaml) is not yet specified. This tool anticipates this feature and implements it.

Therefore, you can provide a bunch of files via upload or as zip file.

Currently supported file types to include are:

  • *.proto to import protobuf files. Proto imports will be resolved as well. Currently, is only a single namespace supported.

Validation

Because the asyncapi-parse is only validating the async api part but not the schema part. This tool does advanced schema validation, including an optional quality check. The quality check tests if there are description and example for all properties.

cli interface

There is a cli interface as well. To integrate all $ref in a async api spec you can run: npm run tsc && node dist/src/cli/join.js --path tests/cli/join_withSubDirs/ --specName toTest.yaml

To change the directory to tests/cli/join_withSubDirs/, open the async api spec toTest.yaml and resolve and integrate all $ref or proto include in a single file printed out on stdout.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages