Skip to content

README.md

Latest commit

 

History

History
142 lines (88 loc) · 3.68 KB

README.md

File metadata and controls

142 lines (88 loc) · 3.68 KB
Raw

RustAPI Examples

This directory contains the in-repository examples for the rustapi-rs facade crate.

Available examples

file_upload

Multipart file upload with Multipart, body limits, and safe filename handling.

Run it with:

cargo run -p rustapi-rs --example file_upload

Then try:

curl -X POST http://127.0.0.1:8080/upload -F "file=@./README.md"

See also the file uploads cookbook recipe.

auth_api

Shows cookie-backed login, session refresh, logout, and session inspection using the built-in session middleware.

Run it with:

cargo run -p rustapi-rs --example auth_api --features extras-session

Then try:

  • POST http://127.0.0.1:3000/auth/login with {"user_id":"demo-user"}
  • GET http://127.0.0.1:3000/auth/me
  • POST http://127.0.0.1:3000/auth/refresh
  • POST http://127.0.0.1:3000/auth/logout

full_crud_api

Shows a compact in-memory CRUD API with list/create/read/update/delete routes.

Run it with:

cargo run -p rustapi-rs --example full_crud_api

Then try:

  • GET http://127.0.0.1:3000/todos
  • POST http://127.0.0.1:3000/todos
  • GET http://127.0.0.1:3000/todos/1
  • PATCH http://127.0.0.1:3000/todos/1
  • DELETE http://127.0.0.1:3000/todos/1

streaming_api

Shows Server-Sent Events (SSE) with a small progress feed.

Run it with:

cargo run -p rustapi-rs --example streaming_api

Then open:

  • http://127.0.0.1:3000/events

jobs_api

Shows an in-memory job queue, enqueue endpoint, and manual worker tick endpoint.

Run it with:

cargo run -p rustapi-rs --example jobs_api --features extras-jobs

Then try:

  • POST http://127.0.0.1:3000/jobs/email
  • POST http://127.0.0.1:3000/jobs/process-next
  • GET http://127.0.0.1:3000/jobs/stats

typed_path_poc

Shows typed path definitions, type-safe route registration, and URI generation with TypedPath.

Run it with:

cargo run -p rustapi-rs --example typed_path_poc

status_demo

Shows the automatic status page and a few endpoints that generate traffic, latency, and failures for demonstration purposes.

Run it with:

cargo run -p rustapi-rs --example status_demo

Then open:

  • http://127.0.0.1:3000/status
  • http://127.0.0.1:3000/fast
  • http://127.0.0.1:3000/slow
  • http://127.0.0.1:3000/flaky

mcp_tools

Demonstrates running your normal HTTP API together with a Native MCP server using in-process invocation (zero network overhead). Selected routes (those tagged "agent") are automatically exposed as discoverable tools for LLMs and agent clients (Claude, Cursor, etc.). Tool calls go through the full RustAPI request pipeline directly (via InvocationMode::InProcess).

Run it with:

cargo run -p rustapi-rs --example mcp_tools --features protocol-mcp

The example starts two listeners:

  • HTTP API on http://127.0.0.1:8080
  • MCP endpoint on http://127.0.0.1:9090 (point your MCP client here)

You can also drive it manually with curl (see the comments at the top of the example file for ready-to-paste JSON-RPC commands).

See also the dedicated cookbook recipes for MCP in-process, the cargo rustapi mcp generate CLI (for any OpenAPI), and stdio transport.

For a more complete, standalone MCP example (with full project structure, ready-to-use Cargo project), see the rustapi-rs-examples repository (05-mcp-server example).

Notes

  • Keep this file aligned with the actual .rs files in this directory.
  • User-facing examples should import from rustapi_rs::prelude::* unless the example is explicitly about internals.
  • New examples should be listed in this file when added under examples/.