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.1.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

openapi_client_builder-0.1.1-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openapi_client_builder-0.1.1.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Darwin/23.5.0

File hashes

Hashes for openapi_client_builder-0.1.1.tar.gz
Algorithm Hash digest
SHA256 53e6fb0fa561187ca9f4dfca0c45d46ae23e39d04dab1c3e357e44916ea03e8f
MD5 90d77aa5037740ef2fd46322f03bcdc1
BLAKE2b-256 5d3eb4bea24c39d87dfe9e95a0b1fd82c865abd97df65f8f1a528d0d6bad955c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_client_builder-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b746bfb26a24bb4b58d48f0db4dcf19dea75e91d93efb0c03ad5c50982a3fedb
MD5 7a782c724d79bd1e4c8aacb08f05c586
BLAKE2b-256 e7750031e550f2517f0a81da80e831c12eeb8dc123537a24ce3c79abcd25c8fa

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