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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: openapi_client_builder-0.1.42.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.42.tar.gz
Algorithm Hash digest
SHA256 07201d323531af364d5a862b9db48486bb2357fb0b68b117ee729b461fcbb0d1
MD5 8a4b8c4067b2f95769259417d3e7f89e
BLAKE2b-256 b488047f57be4b59a398b23bf32f3b8121eda2ad7c2a450c65b71c8d753ae5f3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_client_builder-0.1.42-py3-none-any.whl
Algorithm Hash digest
SHA256 3d2cb36e1931e7058a4437b60d7f746bf9a6c7071001445846b76d67639700b5
MD5 2a2e2834fab54570c34f64c0e69f8cc0
BLAKE2b-256 99ce7c3cc17d05cd0693b8e9e81bb844b6544d08a5300246815543731cb01590

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