vibe-backend
EN繁

Documentation

Every page here is generated at build time from the Markdown files in the docs/ folder of the SDK repository.

Specification · Draft

Spec v1.8

docs/spec-v1.8.md

Specification · Latest

Spec v1.7

docs/spec-v1.7.md

Specification · Older version

Spec v1.5

docs/spec-v1.5.md

Best practices

Overview

docs/best-practices/README.md

Best practices

Auth pipeline: API key

docs/best-practices/auth-api-key.md

Best practices

Auth pipeline: JWT

docs/best-practices/auth-jwt.md

Best practices

CRUD: offset pagination

docs/best-practices/crud-offset-pagination.md

Best practices

CRUD: optimistic locking (ETag / If-Match)

docs/best-practices/crud-optimistic-locking.md

Best practices

CRUD: soft delete

docs/best-practices/crud-soft-delete.md

Best practices

LLM provider setup (compiler endpoint)

docs/best-practices/llm-provider-setup.md

Best practices

Privacy deletion (crypto-shredding + anonymization)

docs/best-practices/privacy-deletion.md

Best practices

Public writes

docs/best-practices/public-writes.md

Best practices

Rate limiting

docs/best-practices/rate-limit.md

Best practices

Refresh token rotation

docs/best-practices/refresh-token-rotation.md

Best practices

sign-token: token issuance capability

docs/best-practices/sign-token.md

Best practices

user.login

docs/best-practices/user-login.md

Best practices

Registration: user.self-register, user.complete-verification and admin user.register

docs/best-practices/user-register.md