Boats NPM | npm.io

BOATS

Boats

An OpenAPI & AsyncAPI templating system with Nunjucks... write less YAML... do more.

What is it?

OpenAPI and AsyncAPI are great, writing yaml is fast... however, there is a lot of copy/paste required. Additionally, managing many routes in a single file is painful. BOATS allows you to reduce the copy and pasting with many built in helpers while at the same time breaking the 1 larger file down into many small files. The output from BOATS is also validated via @apidevtools or @asyncapi.

Quick start

Initialize a new project: npm init -y
Set up BOATS: npx boats --init (follow the prompts)
Build the project: npm run build (outputs in ./build)

Docs & Changelog

Full documentation

Changelog

BOATS CLI

Writing yaml files for BOATS is easier than managing a single file, but to make writing BOATS yml files even easier... there is now a BOATS CLI tool:

https://www.npmjs.com/package/@acrontum/boats-cli

Examples

Simple examples can be found here:

(Refer to the documentation for additional features and details.)

Thanks To

BOATS is nothing without the support of:

Every contributor & issue!
@apidevtools
@asyncapi
js-yaml
Mozilla Nujucks
Jetbrains Open Source Development - Community Support!

asyncapi openapi openapi2 openapi3 snippets swagger openapi template yaml bundle nunjucks yml DDD Documentation-Driven Development

@apidevtools/json-schema-ref-parser @apidevtools/swagger-parser @asyncapi/parser commander deepmerge dotenv fs-extra inquirer js-yaml lodash npm-tool-version-check nunjucks picomatch pluralize ts-replace-all tslib upath

ms_roles_permissions_d @infinitebrahmanuniverse/nolb-boa @everything-registry/sub-chunk-1249

22 days ago

22 days ago

4 months ago

6 months ago

6 months ago

6 months ago

6 months ago

10 months ago

10 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago