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.0.tar.gz (20.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.0-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: archapi-0.3.0.tar.gz
  • Upload date:
  • Size: 20.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.0.tar.gz
Algorithm Hash digest
SHA256 ce537b60f712154860bde437c28e1a3b8c41f04d2fca4c8c4f5cd92e28678f3a
MD5 7db15c73fe6318a80e6b0a625970e6d8
BLAKE2b-256 67a23ed885c9a450090ce8eea245c9a67bef621b39e495b2a5918792bbc7753c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: archapi-0.3.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a8dc67d98d189233d89b9d79992f3abf2a4e62002d4c87ac52c045047ad2f4f5
MD5 b9d3429d7892a545624206a8201465ca
BLAKE2b-256 1121b591e1522fc494540c735305dbba3b47990806001b7143ff14714b0a3a6c

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