Skip to main content

etchblok-test-api

A high-performance bookmark management API with full-text search and intelligent organization.

Overview​

etchblok-test-api is a robust RESTful service designed for managing digital bookmarks at scale. Built with Flask, it provides a clean, layered architecture that separates business logic from data persistence, making it easy to extend or integrate into larger systems.

The API offers a comprehensive suite of features for bookmark lifecycle management, including flexible tagging, hierarchical collections, and a custom-built in-memory search engine. Whether you're building a personal link-saver or a collaborative knowledge base, etchblok-test-api provides the foundational primitives for organizing and discovering web content.

Key Concepts​

  • Bookmark Management Bookmark Management: The core entity representing a saved URL, including metadata like titles, descriptions, and status (active, archived, or trashed).
  • Tagging and Categorization Tagging and Categorization: A flexible system for labeling bookmarks with custom tags and colors to enable multi-dimensional organization.
  • Smart vs. Manual Collections Smart vs. Manual Collections: Logical groupings of bookmarks that can be manually curated or automatically populated based on dynamic filter rules.
  • Search & Discovery Search & Discovery: A high-performance inverted index that provides full-text search capabilities across bookmark titles and descriptions with relevance ranking.
  • Data Access Layer Data Access Layer: A repository-based abstraction that decouples the service logic from the underlying in-memory storage, facilitating future database migrations.
  • Application Configuration Application Configuration: A hierarchical configuration model that supports different environments (Development, Production, Testing) with inherited settings.

Common Use Cases​

  • Building a personal bookmarking dashboard with search and tagging.
  • Creating a shared link library for teams or research groups.
  • Implementing a "read later" service with archiving and trash management.
  • Developing a browser extension backend for saving and organizing web pages.

Getting Started​

To begin building with the API, check out the Getting Started guide for installation instructions. Once you're up and running, explore the Bookmark Fundamentals to understand the core data models or dive into Implementing Full-Text Search to learn how the discovery engine works.