Xeku.Notes.WebApi 0.0.0.7

Xeku.Notes.WebApi

Web API integration module for Xeku.Notes, providing RESTful access to notes, categories, and tags within an ASP.NET Core environment.

繁體中文說明

Features

• XAF Security Integration: Bridges Xeku.Notes data with XAF ASP.NET Core Security system.
• RESTful Endpoints: Enables CRUD operations on notes and hierarchical categories via API.
• Support for Rich Text: Compatible with Tiptap JSON content structure.

Architecture

graph TB
    subgraph External["External Clients"]
        style External fill:#f3e5f5
        App["Mobile/Web App"]
        Agent["AI Agent"]
    end

    subgraph UI["API Layer"]
        style UI fill:#e1f5ff
        Controller["OData/Web Controllers"]
    end

    subgraph Logic["Service Layer"]
        style Logic fill:#fff4e1
        Module["NotesWebApiModule"]
        Security["XAF Security System"]
    end

    subgraph Data["Data Layer"]
        style Data fill:#e8f5e9
        Note["Note Entity"]
        Category["Category Entity"]
    end

    App --> Controller
    Agent --> Controller
    Controller --> Module
    Module --> Security
    Security --> Note
    Security --> Category

Installation

dotnet add package Xeku.Notes.WebApi

Usage (Startup.cs)

In your Web API project's Startup.cs, register the Notes business objects within AddXafWebApi to enable API access from the frontend or external agents:

services.AddXafWebApi(builder => {
    builder.ConfigureOptions(options => {
        // Register Notes business objects for API access
        options.BusinessObject<Note>();
        options.BusinessObject<NoteCategory>();
        options.BusinessObject<NoteTag>();
    });
    // ... other configurations
});

AI Agent Integration

Use Cases

• Automated Summarization: An agent can retrieve note content via API, summarize it, and update the note.
• Intelligent Categorization: Automatically assign categories to new notes based on content analysis.
• Content Sync: Synchronize notes between external tools and Xeku.Notes dynamically.

Best Practices

1. Security first: Ensure the API user has appropriate read/write permissions for Note entities.
2. Filtering: Use OData query options to filter notes by Owner or Category for efficiency.
3. Batch Updates: Use batch requests when updating multiple tags or categories to reduce latency.

Related Packages

• Xeku.Notes - Core notes business objects.
• Xeku.Notes.Blazor - Blazor integration and TreeGrid editor.

License

MIT License