JSPM

@shopware/api-gen

0.0.0-canary-20240130094823
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3472
  • Score
    100M100P100Q125587F
  • License MIT

Shopware CLI for API client generation.

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@shopware/api-gen) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    shopware/frontends - api-gen

    Welcome to @shopware/api-gen CLI. Generate TypeScript schemas from Shopware OpenAPI specification.

    After generating schemas, you can use them in fully typed API Client.

    Usage

    # Using pnpm
pnpx add @shopware/api-gen [command]

# Using npm
npx i @shopware/api-gen [command]

    Commands

    generate

    Transform OpenAPI specification from JSON file to Typescript schemas.

    options:

    pnpx @shopware/api-gen generate --help

    loadSchema

    Load OpenAPI specification from Shopware instance and save it to JSON file.

    options:

    pnpx @shopware/api-gen loadSchema --help

    Changelog

    Full changelog for stable version is available here

    Latest changes: 0.0.0-canary-20240130094823

    Minor Changes

    • #534 6170dca Thanks @patzick! - loadSchema command added by splitting generate command

    • #534 6170dca Thanks @patzick! - Sorting paths in the same order by api patchs

    • #534 6170dca Thanks @patzick! - Command generate has been splitted and doing only transformation from json to d.ts file

    • #534 6170dca Thanks @patzick! - Schema operations is now a generic type to help with overriding types

    Patch Changes