bazable extract

Scan code and extract API endpoints

Scans your codebase for API calls and adds any undocumented endpoints to the contract.

Usage

bazable extract [options]

Options

-r, --payloads · boolean

Also infer request payload schemas.

-s, --preset · string

Use a pre-configured extraction pattern. One of py, php, go, rb, js, ax.

--pattern · regex

Custom regex for URL extraction.

--ext · string[]

File extensions to scan (for example, .py .rb).

--ignore · string[]

Glob patterns to ignore (for example, venv dist).

--wrapper · string[]

Custom API wrapper function names.

Examples

Standard

bazable extract -r

Provenance and inference metadata

Every extraction records provenance (the file, line, and column of each call site) and field-level metadata (inferred vs confirmed, source value, and confidence) on the endpoint entry:

bazable.config.json

{
  "endpoints": {
    "POST https://api.example.com/v1/users": {
      "request": { "email": "string", "age": "number" },
      "request_meta": {
        "email": { "inferred": true, "confidence": "high", "source_value": "[e-mail]" },
        "age":   { "inferred": true, "confidence": "high", "source_value": 30 }
      },
      "provenance": [
        { "file": "src/pages/signup.tsx", "line": 42, "column": 18 }
      ]
    }
  }
}

Use bazable review to render this as a human-readable audit report with flags for fields that need confirmation.

Accuracy notes

• HTML script blocks: line numbers in provenance are computed against the whole HTML file, not the inner <script> block, so they point straight to the call site in your editor.
• Cross-block variables: payloads declared as a variable in one <script> block and used in another are resolved. Bazable collects variable definitions across all blocks in a file before matching them to API calls.
• New endpoints are seeded with schema_status: "unverified" so they show up in bazable inspect until you confirm the schema.

Run bazable inspect after extraction to validate that your code still matches the contract, and bazable review to audit which inferred fields are low confidence.