Skip to main content

A tool that automatically generates client-side APIs based on the OpenAPI specification. Simplify the process of interacting with APIs by creating client libraries from OpenAPI definitions, enabling seamless integration and communication with backend services. The tool generates TypeScript request files and currently supports Nuxt framework, with plans to extend support to SvelteKit in the future.

Project description

openapi_client_builder

A tool that automatically generates client-side APIs based on the OpenAPI specification. Simplify the process of interacting with APIs by creating client libraries from OpenAPI definitions, enabling seamless integration and communication with backend services.

The tool generates TypeScript request files and currently supports Nuxt framework, with plans to extend support to SvelteKit in the future.

Usage:

$ api-cli [OPTIONS] COMMAND [ARGS]...

Options:

  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • api
  • type

api-cli api

Usage:

$ api-cli api [OPTIONS]

Options:

  • --host TEXT: [default: 127.0.0.1]
  • --port TEXT: [default: 8000]
  • --path TEXT: [default: /api/openapi.json]
  • --url TEXT
  • --output TEXT: [default: ./dist]
  • --name TEXT: [default: db_api.d.ts]
  • --help: Show this message and exit.

api-cli type

Usage:

$ api-cli type [OPTIONS]

Options:

  • --host TEXT: [default: 127.0.0.1]
  • --port TEXT: [default: 8000]
  • --path TEXT: [default: /api/openapi.json]
  • --url TEXT
  • --output TEXT: [default: ./dist]
  • --name TEXT: [default: api.types.d.ts]
  • --help: Show this message and exit.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openapi_client_builder-0.1.2.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

openapi_client_builder-0.1.2-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file openapi_client_builder-0.1.2.tar.gz.

File metadata

  • Download URL: openapi_client_builder-0.1.2.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.11.0 Darwin/24.0.0

File hashes

Hashes for openapi_client_builder-0.1.2.tar.gz
Algorithm Hash digest
SHA256 b334307da3007cfa05010640e966c324113d2dbbd6d20e7a6f60c2f1feb16c34
MD5 d8e33aa000769750f1d115837dafe14d
BLAKE2b-256 ec5509be5a9d786192a690736123b217d44942b5eec96429704767b02b6385e0

See more details on using hashes here.

File details

Details for the file openapi_client_builder-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_client_builder-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 abd9c99dc46c5c3980bd5f09e9f581aff946763defed1d92b5d4dae2d0a4c008
MD5 06e1e8aa4abd071d68def43bbe738f86
BLAKE2b-256 2ae43eb0f2a980c10eafafa078523737008420c19f8a08dd9e7ae63458781b69

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page