OpenAPIQT

OpenAPIQT is a GUI builder of OpenAPI. OpenAPI can be used to build pretty interactive UI of your API, as well as generate code out of your API model, using Swagger

Description

OpenAPIQT будет представлять собой мощный инструмент для разработчиков, позволяющий легко создавать и управлять документацией OpenAPI для REST API. Приложение будет включать в себя следующие ключевые компоненты:

• Главный экран: Интуитивно понятный интерфейс, где пользователи смогут начать новый проект или открыть существующий.
• Редактор схем: Модуль для создания и редактирования JSON OpenAPI схем с поддержкой автозаполнения и подсказок.
• Генератор swagger.yaml: Функция, позволяющая пользователям собирать swagger.yaml файл, проверять его на ошибки и сохранять.
• Документация и поддержка: Встроенная справка и примеры использования для облегчения работы с приложением.

Ожидаемые результаты:

• Создание полноценного десктопного приложения для работы с документацией OpenAPI (Swagger)
• Упрощение процесса создания и редактирования OpenAPI схем для разработчиков.
• Повышение качества документации REST API за счет удобного интерфейса и функционала приложения.

Getting Started

Dependencies

• Python
• PyQT6

more in pyproject.toml

Installing

git clone https://github.com/HayKor/OpenAPIQT.git
cd OpenAPIQT
python -m venv .venv

Install dependencies using poetry:

poetry install

Or using pip:

pip install -r requirements.txt

Executing program

Activate the venv first:

source .venv/scripts/activate

Run the main.py file:

python openapiqt/main.py