This package is an NPM initializer to generate an API client SDK based on OpenAPI specification.
This package is simplifying the start of new SDK repository.
npm create @ama-sdk typescript <package-name> -- [...options]
or
yarn create @ama-sdk typescript <project-name> [...options]
[!WARNING] Please notice that the command
yarn create
is not available for versions >= 2.0.0 (see Yarn cli commands).
You can generate an environment with a specific package manager thanks to the --package-manager
options:
npm create @ama-sdk typescript <project-name> -- --package-manager=yarn [...options]
-
--package-manager
: Node package manager to be used (npm
andyarn
are available). -
--debug --no-dry-run
: Enable schematics debug mode (dry-run is not currently supported). -
--o3r-metrics
: Enable or disable the collection of anonymous data for Otter -
--exact-o3r-version
: use a pinned version for otter packages. -
--spec-path
: Path to the swagger/open-api specification used to generate the SDK -
--spec-package-name
: The npm package name where the spec file can be fetched -
--spec-package-path
: The export path inside the package.json where to find the spec file. Defaults to ./openapi.[yml|yaml|json] -
--spec-package-version
: The version to target for the npm package where the spec file can be fetched -
--spec-package-registry
: The npm registry where the spec file can be fetched
[!NOTE] If
--spec-path
or--spec-package-name
is specified, the SDK will be generated based on this specification at the creation time.
[!NOTE]
--spec-package-registry
option assumes that the authentication is set up globally (See npm setup, yarn setup)