https://github.com/yinchi/openapi-cli

CLI for working with APIs using the OpenAPI specifications
https://github.com/yinchi/openapi-cli

openapi openapi-cli python-click

Last synced: 9 months ago
JSON representation

CLI for working with APIs using the OpenAPI specifications

• Host: GitHub
• URL: https://github.com/yinchi/openapi-cli
• Owner: yinchi
• License: mit
• Created: 2025-01-28T23:32:59.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2025-01-29T01:19:35.000Z (11 months ago)
• Last Synced: 2025-01-29T01:20:17.897Z (11 months ago)
• Topics: openapi, openapi-cli, python-click
• Language: Python
• Homepage:
• Size: 10.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# CLI for working with APIs using the OpenAPI specifications

![GitHub License](https://img.shields.io/github/license/yinchi/openapi-cli)

![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fyinchi%2Fopenapi-cli%2Frefs%2Fheads%2Fmain%2Fpyproject.toml)

![GitHub last commit (branch)](https://img.shields.io/github/last-commit/yinchi/openapi-cli/main?label=last%20commit%20(main))

Author: Yin-Chi Chan

> [!WARNING]

> This Python package is very preliminary. There will be bugs(!), and not all OpenAPI specifications will be able to be parsed.

>

> Check [TODO.md](TODO.md) for a list of features to be added.

### Running the CLI app

- Option 1: `uv run`

    ```bash

    cd /path/to/project

    uv run openapi 

    ```

- Option 2: global install with `pipx` (editable)

  ```bash

  cd /path/to/project

  pipx install -e .

  openapi 

  ```

### Documentation

Run `openapi  -h` to see usage information for each command or `openapi -h` for a list of commands.

### Screenshot

![Screenshot of the openapi CLI app](docs/img/screenshot_readme.png)