Skip to main content

Architecture-preserving REST API synthesis library

Project description

ArchAPI

ArchAPI is a Python library for architecture-preserving REST API generation.

It scans an existing backend project, detects the framework, understands the project structure, plans a REST API, generates framework-specific files, validates the output, and writes files only when explicitly requested.


Current Status

Current checkpoint: Phase 3 complete

Completed:

  • Functional Python package
  • Express TypeScript adapter
  • FastAPI adapter
  • Generic fallback adapter
  • Framework detection
  • Project scanning
  • API architecture model
  • Confidence scoring
  • Low-confidence blocking
  • Strict config mode
  • REST intent planner
  • Code generation
  • Dry-run generation
  • Safe apply
  • Overwrite protection
  • Cache and changed-file detection
  • Secret scanner
  • Context redaction
  • Policy gate
  • Architecture consistency score
  • Command validation
  • Unified regression test suite

Supported Frameworks

Dedicated generation support currently exists for:

  • Express TypeScript
  • FastAPI

Other frameworks may be detected, but they currently use the generic fallback adapter.


Installation

From the project root:

pip install -e .

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

archapi-0.3.1.tar.gz (21.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

archapi-0.3.1-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

Details for the file archapi-0.3.1.tar.gz.

File metadata

  • Download URL: archapi-0.3.1.tar.gz
  • Upload date:
  • Size: 21.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.9

File hashes

Hashes for archapi-0.3.1.tar.gz
Algorithm Hash digest
SHA256 9b2441b35dfbee565448a324621563c91771e3294710f32f0b3dcb31e2170fd4
MD5 b2b42eb2e9360651524c120c86e20e26
BLAKE2b-256 fc621501553aec34a86b9fc18b79c4281404792af889781a2661d45245abf61a

See more details on using hashes here.

File details

Details for the file archapi-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: archapi-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 27.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.9

File hashes

Hashes for archapi-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 33e56362a22aa920bd288715960fb6aa5f995da4f014b3f61d2751450a5cb53b
MD5 5056f2e458d73f043d5422b326c3699d
BLAKE2b-256 9be76cd931b02f71aab0c4208ab5926b41ce961085512dcb8c07546529c3464a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page