{"id":25477265,"url":"https://github.com/nicksenap/qi","last_synced_at":"2026-02-06T22:02:27.150Z","repository":{"id":270041915,"uuid":"909162515","full_name":"nicksenap/qi","owner":"nicksenap","description":"Qi is a tool that enhances contract-based development workflow by providing more intelligent code generation from OpenAPI specifications.","archived":false,"fork":false,"pushed_at":"2024-12-29T21:37:00.000Z","size":189,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-18T02:49:41.069Z","etag":null,"topics":["api-first","code-generation","contract-first-development","python","spring-boot"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nicksenap.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-12-27T22:34:47.000Z","updated_at":"2025-02-16T08:32:56.000Z","dependencies_parsed_at":"2025-05-18T02:39:57.645Z","dependency_job_id":"4b722ffe-ba4b-4487-aac7-7bda01859407","html_url":"https://github.com/nicksenap/qi","commit_stats":null,"previous_names":["nicksenap/qi"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nicksenap/qi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicksenap%2Fqi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicksenap%2Fqi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicksenap%2Fqi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicksenap%2Fqi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nicksenap","download_url":"https://codeload.github.com/nicksenap/qi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicksenap%2Fqi/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266959850,"owners_count":24012574,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-25T02:00:09.625Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-first","code-generation","contract-first-development","python","spring-boot"],"created_at":"2025-02-18T13:38:42.498Z","updated_at":"2026-02-06T22:02:27.143Z","avatar_url":"https://github.com/nicksenap.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Qi - Better Workflow for Contract-Based Development\n\n[![Test](https://github.com/nicksenap/qi/actions/workflows/test.yml/badge.svg)](https://github.com/nicksenap/qi/actions/workflows/test.yml)\n[![codecov](https://codecov.io/gh/nicksenap/qi/graph/badge.svg)](https://codecov.io/gh/nicksenap/qi)\n\nQi (契, means contract in Chinese) is a tool that enhances contract-based development workflow by providing more intelligent code generation from OpenAPI specifications. Currently supporting Java Spring Boot, with planned support for FastAPI and other frameworks.\n\n## Features\n\n- Automatically downloads and manages OpenAPI Generator CLI\n- Supports custom directory mapping via `x-qi-dir` extension\n- Tracks generated files for smart updates\n- Currently supports Java Spring Boot projects (FastAPI and other frameworks coming soon)\n\n## Installation\n\nFirst, make sure you have `uv` installed:\n```bash\npip install uv\n```\n\nThen install QI:\n```bash\nuv pip install .\n```\n\n## Usage\n\n### Basic Usage\n\n```bash\nqi generate path/to/spec.yaml -o ./target\n```\n\n### With Configuration File\n\nCreate a configuration file `qi-config.yaml`:\n\n```yaml\nopenapi_generator_version: \"6.6.0\"\njava_package_base: \"com.example\"\nmodel_package: \"model\"\napi_package: \"api\"\ntracking_file: \".qi-tracking.yaml\"\n```\n\nThen run:\n\n```bash\nqi generate path/to/spec.yaml -c qi-config.yaml -o ./target\n```\n\n### OpenAPI Specification Example\n\n```yaml\ncomponents:\n  schemas:\n    User:\n      x-qi-dir: \"domain/user/model\"  # Custom directory for User model\n      type: object\n      properties:\n        id:\n          type: string\n          format: uuid\n        name:\n          type: string\n```\n\n## Development\n\n### Setup\n\n```bash\n# Install development dependencies\nmake install.dev\n\n# Run tests\nmake test          # All tests\nmake test.unit     # Unit tests only\nmake test.integration  # Integration tests only\n\n# Code quality\nmake lint          # Check code style\nmake fix           # Auto-fix code style issues\nmake check         # Run all quality checks\n```\n\n## Requirements\n\n- Python 3.10+\n- Java Runtime Environment (JRE) for OpenAPI Generator\n- uv for dependency management\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnicksenap%2Fqi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnicksenap%2Fqi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnicksenap%2Fqi/lists"}