How thomasheckmann/zxinfo-api-v5 works
ZXInfo API v5 exposes ZXDB search and lookup capabilities over HTTP, backed by Elasticsearch. The main request path is client → Express app → versioned routes → feature handler → search/helper or Elasticsearch → response. The repository also contains legacy search-index generators and import scripts for building/populating the search index; their internal wiring is not shown in the excerpts, so those relationships are left unasserted.
Main entry points: routes.js API routes · elastic.js Elasticsearch client · entries.js Entry lookup · search.js Text search
Components 21
API routing
- Express app
app.js - API routes
v5/routes.js
ZXDB features
- Entry lookup
v5/entries/entries.js - File check
v5/filecheck/filecheck.js - File search
v5/filesearch/filesearch.js - Text search
v5/search/search.js - Suggestions
v5/suggest/suggest.js - Typeahead
v5/typeahead/typeahead.js
Search infrastructure
- Query builders
v5/search/queryTerms.js - Search executor
v5/search/helpersSearch.js - Request defaults
v5/common/helpersRequest.js - Output utilities
v5/common/utils.js - Elasticsearch client
v5/common/elastic.js
Index preparation
- MariaDB connection
search-index/dbConfig.js - Index generator
search-index/index.js - Index generator v1
search-index/index-v1.js - Debug indexer
search-index/index-debug.js - ZXDB import scripts
es-import
Other components
- API client
- Elasticsearch
- MariaDB
Connections 28
- API client → Express app: sends requests
README.md - Express app → API routes: mounts routes
app.js - API routes → Entry lookup: routes requests
v5/routes.js - API routes → File check: routes requests
v5/routes.js - API routes → File search: routes requests
v5/routes.js - API routes → Text search: routes requests
v5/routes.js - API routes → Suggestions: routes requests
v5/routes.js - API routes → Typeahead: routes requests
v5/routes.js - Text search → Query builders: builds queries
v5/search/search.js - Entry lookup → Query builders: builds filters
v5/entries/entries.js - Text search → Search executor: executes search
v5/search/search.js - Entry lookup → Search executor: executes search
v5/entries/entries.js - Search executor → Elasticsearch client: queries
v5/search/helpersSearch.js - Entry lookup → Elasticsearch client: queries
v5/entries/entries.js - File search → Elasticsearch client: searches and looks up
v5/filesearch/filesearch.js - File check → Elasticsearch client: checks records
v5/filecheck/filecheck.js - Suggestions → Elasticsearch client: queries suggestions
v5/suggest/suggest.js - Typeahead → Elasticsearch client: queries completions
v5/typeahead/typeahead.js - Elasticsearch client → Elasticsearch: sends queries
v5/common/elastic.js - Search executor → Output utilities: formats results
v5/search/helpersSearch.js - Text search → Output utilities: sorts results
v5/search/search.js - Entry lookup → Output utilities: formats entries
v5/entries/entries.js - File search → Request defaults: uses fallback
v5/filesearch/filesearch.js - Index generator → MariaDB connection: uses connection
search-index/index.js - Index generator v1 → MariaDB connection: uses connection
search-index/index-v1.js - Debug indexer → MariaDB connection: uses connection
search-index/index-debug.js - MariaDB connection → MariaDB: connects to
search-index/dbConfig.js - ZXDB import scripts → Elasticsearch: populates index
README.md