NioFlow Documentation

Professional Framework Guide

Start from installation and move step-by-step to routing, authentication, frontend integration, deployment, and production hardening.

What You Will Build

This guide is focused on practical delivery. By the end, you will have a real Java backend using NioFlow routes, structured middleware, JWT-protected APIs, health and readiness probes, and a cloud-ready runtime setup that can be deployed to Docker, Render, or Railway.

Every section includes copy-paste examples and production defaults so you can move from local proof-of-concept to release candidate without rewriting the architecture.

1. Getting Started

Download options, Maven vs manual setup, project bootstrap, and port registration strategy.

2. Routing + Frontend

Build custom routes, parse request body/path params, and integrate with frontend fetch clients.

3. Auth + Security

Implement signup/login, generate JWT tokens, protect route groups, and set security baselines.

4. Operations + Deployment

Operational readiness, deploy strategy, probes, incident basics, and release delivery workflow.

5. Reference

Configuration matrix, endpoint reference, starter zip endpoint design, and troubleshooting.

Recommended Learning Path

Follow sections in order. Each page is designed to prepare the next one, so you avoid missing env, middleware, or deployment prerequisites.

Code-First Explanations

Examples are intentionally complete, not pseudo-code. You can use snippets directly in your project, then incrementally adapt naming and structure.

Production Mindset

Docs prioritize safe defaults: explicit CORS origin, strong JWT secret, controlled error exposure, health probes, and release reproducibility.

Architecture At A Glance

  1. Requests are accepted by the NIO event loop and mapped through declarative routing.
  2. Middleware executes in order for auth, rate-limit, logging, observability, and policy controls.
  3. Handlers operate on a typed HTTP context and return JSON/text with explicit status control.
  4. Optional persistence and asynchronous work offload keep IO handling responsive.
  5. Ops endpoints (health, readiness, metrics) integrate with monitors and rollout checks.