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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: openapi_client_builder-0.1.41.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.41.tar.gz
Algorithm Hash digest
SHA256 b40b0ee4b6b1f78b7754f759719d2df59a85b31a7ca7b4a17db52e29d72a4e8a
MD5 1d4c48cfe6b7f7f84dac5d40d1c1e3c0
BLAKE2b-256 d8313c049e8fcf2a377f457c005adbd86d2e450085d96aca7da28e82ad0da71e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_client_builder-0.1.41-py3-none-any.whl
Algorithm Hash digest
SHA256 eb123fde894661d684a44384cb3561da80e67ca51876dae2c4ec9e1531e7b1f8
MD5 2b972845fc24e7e8a732e888705a344b
BLAKE2b-256 5e639e12dc8bb2479c83a4a44c75696c38acf56812aa233e582680a83496f3f1

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