Documentation
가이드, 튜토리얼, 레퍼런스 문서
카테고리별로 문서를 살펴보세요. 대부분의 문서는 독립적으로 읽을 수 있고, 코드 예제에는 구문 강조가 적용되어 있습니다.
추천
퀵스타트
5분 안에 첫 파이프라인을 설치하고 실행해 보세요.
튜토리얼
CLI Schematic과 VSCode 흐름을 따라 첫 회로를 만들어 봅니다.
시작하기
코드 예제와 학습 경로를 함께 보여주는 인터랙티브 개요.
예제 탐색기
필터와 소스 코드를 포함한 68개 공개 워크스페이스 예제.
패턴 카탈로그
코드 예제와 함께 보는 12가지 검증된 패턴.
기능 현황 보드
실시간 모듈 현황, 버전, 검증 명령.
시작하기
퀵스타트
Ranvier를 설치하고 5분 안에 첫 타입 파이프라인을 실행하세요.
Hello World
처음부터 Transition과 Axon 파이프라인을 만들어 보세요.
튜토리얼: TODO API
JWT 인증, CRUD, Guard를 포함한 완전한 REST API를 만들어 보세요.
시작 가이드
개념, 설정, 첫 프로젝트를 한 번에 익히는 온보딩 가이드.
시작하기 개요
코드 예제와 학습 경로를 함께 보여주는 인터랙티브 개요.
튜토리얼
hello-world, CLI Schematic, VSCode 확장 흐름을 단계별로 따라가는 튜토리얼.
심화 튜토리얼: 결제 파이프라인
보상, 분기, Schematic diff, 테스트까지 포함한 엔드투엔드 결제 Saga.
철학과 아키텍처
소개
Ranvier는 실행 구조와 제어 흐름을 명시하는 타입 기반 의사결정 엔진입니다.
철학 개요
Opinionated Core, Flexible Edges를 설명하는 핵심 설계 철학.
설계 철학 (원문)
Ranvier 저장소의 전체 설계 철학 문서.
설계 원칙
핵심 설계 선택을 기록한 아키텍처 결정 문서(ADR).
핵심 패러다임
네 기둥: Transition, Outcome, Bus, Schematic.
왜 Opinionated Core?
제약을 통한 정체성, 학습 곡선, 일관성.
왜 Flexible Edges?
생태계 통합, 점진적 마이그레이션, 사용자 자율성.
경계 맵
코어가 끝나고 확장 지점이 시작되는 경계.
결정 프레임워크
Ranvier 방식, 생태계 방식, 하이브리드 접근 중 선택.
코드 예제
실전 패턴: 순수 Ranvier, Tower 통합, 하이브리드, 이커머스.
가이드
Bus 접근 패턴
read(), get(), require(), try_require() 메서드 결정 트리.
영속성 운영 런북
체크포인트 복구, PostgreSQL/Redis 저장소 설정, 보상 훅.
OTel 운영 플레이북
OpenTelemetry 수집기 설정, 트레이스 내보내기, 메트릭 설정.
보안 강화
SQL 인젝션 방지, 타이밍 안전 인증, 오류 정보 마스킹, OWASP 대응.
프로덕션 준비 체크리스트
배포 전 체크리스트: 인증, 보안, 관측성, 복원력, CI/CD.
인증 비교
Transition 기반 인증과 Tower 기반 인증을 7가지 항목과 벤치마크로 비교합니다.
Cookbook
Guard 패턴
글로벌/라우트별 Guard 구성, guards![] 매크로, 커스텀 Guard 구현.
HttpIngress 패턴
post vs post_typed, 경로 파라미터, bus_injector, 정적 자산, WebSocket.
Bus 패턴
insert/read/write, DB 풀 공유, newtype 충돌 방지, Guard Bus 타입.
Saga 보상
then_compensated, LIFO 순서, 보상 실패 처리, 영속성.
LLM 파이프라인
LlmTransition, 병렬 도구 호출, PII 필터링, 재시도/타임아웃 복원력.
데이터베이스 마이그레이션
sqlx/refinery 통합, Docker Compose 순서, CI/CD 파이프라인 설정.
스트리밍 패턴
StreamingTransition, StreamingAxon, SSE 엔드포인트, 스트림 타임아웃, 테스트.
멀티테넌트 격리
TenantGuard 추출, Bus 전파, DB 격리, 테넌트별 레이트 리밋.
외부 발신 패턴
HMAC 웹훅 전송, 멀티채널 알림, 재시도/DLQ, 서킷 브레이커.
LLM 게이트웨이
다중 프로바이더 라우팅, 토큰 수 계산 Guard, 비용 예산, SSE 스트리밍 프록시.
PII 마스킹
PII 탐지 Guard, 정규식 패턴, 마스킹 전략, 이중 스캔 파이프라인.
빌링 & 미터링
Redis API 미터링 Guard, 요금제 관리, 초과 처리, 사용량 리포트.
데이터 대사
퍼지 매칭, 가중 점수, Outcome 분류, 대사 리포트.
Outcome 패턴
try_outcome! 매크로, Outcome 컴비네이터 (from_result, and_then, map_fault), Bus::get_cloned().
Outcome::from_result
from_result/from_result_ctx로 Result<T, E>를 Outcome으로 변환 — sqlx, serde, reqwest 패턴.
명시적 검색 파라미터
PageParams, Paginated<T>, from_bus() 기반 사용자 정의 검색 구조체를 설명합니다.
JSON Outcomes
get_json_out, post_typed_json_out, BusHttpExt, json_outcome()을 활용해 라우트 경계에서 타입이 지정된 JSON을 다룹니다.
Saga 보상 패턴 (심화)
결제, 보험, 온보딩 도메인 예시를 통한 고급 Saga 패턴.
캐스케이드 스크리닝
페일패스트 순차 필터 파이프라인 — AML/KYC, 콘텐츠 모더레이션, 관세.
다단계 파이프라인
상태가 단계별로 진전되는 파이프라인을 AI 에이전트, ETL, IoT 사례로 설명합니다.
통합
Tower 통합
Tower Service/Layer 미들웨어와 Ranvier Transition 통합.
actix-web 통합
actix-web 핸들러와 추출기에서 Ranvier Transition 사용.
Axum + Ranvier 하이브리드 가이드
Axum이 HTTP 처리를 맡고 Ranvier가 복잡한 로직을 담당하는 하이브리드 패턴을 설명합니다.
Ranvier와 Axum, 언제 써야 할까
Ranvier, Axum, 또는 둘을 함께 써야 할 상황을 결정표로 정리했습니다.
운영
배포 가이드
Docker 멀티 스테이지 빌드, Kubernetes 매니페스트, 환경 설정.
성능 튜닝
프로파일링, 연결 풀, 비동기 패턴, 릴리스 빌드 최적화.
패턴 카탈로그
재사용 패턴: 사가, 팬아웃/팬인, 유효성 검사 파이프라인 등.
API 안정성 계약
고정된 트레잇, 지원 중단 정책, v1.0 semver 약속.
제품 매뉴얼
Ranvier 매뉴얼
핵심 런타임 가이드: Transition, Outcome, Bus, Axon, Schematic.
CLI 매뉴얼
ranvier-cli의 명령어와 아티팩트 흐름.
VSCode 매뉴얼
ranvier-vscode 설정 및 진단 워크플로우.
심층 분석
HTTP 심층 분석
HTTP Ingress, Router DSL, 바디 핸들링, 미들웨어.
표준 라이브러리
내장 노드: Logic, Flow, Data 카테고리.
영속성 심층 분석
크래시 복구, 영속 어댑터, 사가 패턴.
관측성 심층 분석
Inspector, Prometheus 메트릭, OTLP 트레이싱 파이프라인.
인증 심층 분석
Guard 노드, IAM 프레임워크, 세션 관리 패턴.
운영 심층 분석
설정, 헬스 프로브, 구조화된 로깅, 텔레메트리.
배포 심층 분석
Docker 멀티 스테이지 빌드, Kubernetes 매니페스트, 프로덕션 패턴.
패턴과 예제
적용 사례
Saga, 스크리닝, 파이프라인, IoT, 트리아지, 규칙 체인을 아우르는 6가지 실전 사례.
Ranvier 샘플
typed-state-tree, basic-schematic, hello-world를 따라 해보는 핵심 예제 모음.
CLI 샘플
Schematic과 Timeline 입력으로 CLI 산출물을 생성하는 예제.
VSCode 샘플
Circuit View와 이슈 탐색 흐름을 재현하는 예제.
예제 탐색기
티어/카테고리 필터와 학습 경로를 제공하는 인터랙티브 예제 탐색기.
패턴 카탈로그 (인터랙티브)
난이도와 코드 예제를 함께 살펴볼 수 있는 12가지 검증된 패턴.