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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: openapi_client_builder-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 a3e0db15f5c8190cdbb60e33cbce4476beb852851a661c3ecdf4edc4063f6e86
MD5 0e44ad07cff26e36bb4c20ee73f17d1d
BLAKE2b-256 93895480fdc2a3d325abe51a7fd427cd4f14b367feac291a5199f972a80f56bc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_client_builder-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f86ded8988a8929e071f7a13469a55fea686ef507475bd7b31c27a78290d5243
MD5 7a0ded6de99f3291e9dd006f7183d5ed
BLAKE2b-256 b916fae163875f950dce6c71b5ff6c386955847bdcc1940ef0a3491a82dbc416

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