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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: openapi_client_builder-0.1.4.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.1 Linux/6.5.0-1025-azure

File hashes

Hashes for openapi_client_builder-0.1.4.tar.gz
Algorithm Hash digest
SHA256 8db87676c1d3616903d8c281cf0854478186783cdf860a200cbe28046a9fe656
MD5 74f2f1583ac8a466459eeb6c7ac1ee0e
BLAKE2b-256 51960e7df168edce82d8b54a7f9d66ebb5cc4776a2f855b3b6c397b72ed33462

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_client_builder-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 58ec794c484ddae70623c94316fbb2eef782089370da53beeb44adafbb699269
MD5 236b3e31e45a27188d90384132e2059d
BLAKE2b-256 3915ed3110afcaf258f78913e4106044234e0f8c706a263ae7749351dbaafc67

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