Skip to main content

Guides

Each guide does one task end to end: what you need first, the complete code, how to run it, and where to go next.

New to Juneau? Work through Getting Started first; the guides assume you have.

  1. Build a REST API on Spring Boot: a JSON pet API on Spring Boot's Tomcat, with a Spring bean injected into the resource. About 15 minutes.
  2. Secure an endpoint with JWT and OAuth: require a bearer token, accept JWTs and opaque OAuth tokens, and check scopes. About 20 minutes.
  3. Test an endpoint with MockRestClient: unit-test a REST resource in-process, with no server or port. About 10 minutes.
  4. Call an existing REST API with a typed proxy: describe an API as a Java interface and call it through the next-generation client. About 15 minutes.
  5. Serialize a type Juneau doesn't know: write a swap so a class you can't change round-trips through JSON. About 10 minutes.
  6. Externalize config with INI/YAML and variables: move settings into an INI or YAML file and fill them from system properties and the environment. About 15 minutes.
  7. Generate OpenAPI docs for your API: serve OpenAPI 3.1, Swagger v2, Redoc and Swagger UI from your resource's annotations. About 10 minutes.
  8. Building a Console Page: add a page to a Juneau admin console, from the host resource and templates to a table card fed by a data endpoint. About 30 minutes.
  9. MCP Quickstart: get a Model Context Protocol server and client talking to each other. About 5 minutes.