Armeria examples

• annotated-http-service

  • Learn how to write an HTTP service using annotations.
  • See Annotated services.

• annotated-http-service-kotlin

  • Learn how to write an HTTP service using annotations with Kotlin Coroutines.
  • See Kotlin coroutines support.

• context-propagation

  • Learn how to propagate Armeria's RequestContext for use in scenarios like tracing.
  • dagger provides an example using the Dagger asynchronous framework for automatic propagation.
  • manual provides an example manually propagating the context with Java's standard CompletableFuture.
  • reactor provides an example using the Reactor asynchronous framework for automatic propagation.
  • rxjava provides an example using the RxJava3 asynchronous framework for automatic propagation.

• grpc

  • Learn how to write a gRPC service with Armeria gRPC module.
  • See Running a gRPC service and Calling a gRPC service.

• grpc-kotlin

  • Learn how to write a gRPC service with Armeria gRPC module (Kotlin).
  • See Running a gRPC service and Calling a gRPC service.

• grpc-reactor

  • Learn how to write a gRPC service with Armeria gRPC module, reactive-grpc and Project Reactor libraries for asynchronous processing with non-blocking back pressure.
  • See Running a gRPC service and Calling a gRPC service.

• proxy-server

  • Learn how to make a proxy server which leverages client side load balancing.
  • See Client-side load balancing

• resilience4j-spring

  • Learn how to use Armeria with Resilience4j and Spring.

• saml-service-provider

  • Learn how to authenticate users using SAML.
  • See SAML Single Sign-on.

• server-sent-events

  • Learn how to serve Server-Sent Events.
  • See Serving Server-Sent Events.

• spring-boot-minimal

  • Learn how to use Armeria with the minimal Spring Boot dependencies.

• spring-boot-minimal-kotlin

  • Learn how to use Armeria with the minimal Spring Boot dependencies (Kotlin).

• spring-boot-tomcat

  • Learn how to make Armeria serve your Spring Boot web application.

• spring-boot-webflux

  • Learn how to make Armeria serve your Spring Boot reactive web application.
  • See Using Armeria with Spring WebFlux.

• dropwizard

  • Learn how to make Armeria serve your Dropwizard web application.
  • See Using Armeria with Dropwizard.

• static-files

  • Learn how to serve static files.
  • See Serving static files.

• thrift

  • Learn how to write a Thrift service with Armeria Thrift module.
  • See Running a Thrift service and Calling a Thrift service.
  • Install Thrift compiler locally before generating Thrift services.
    • Use brew install thrift for macOS.

Configure -parameters javac option

You can omit the value of @Param if you compiled your code with -parameters javac option. Please refer to Configure -parameters javac option for more information.

How to run

• Use run or bootRun task to run an example from Gradle.
• See Open an existing Gradle project to import an example into IntelliJ IDEA.
• See Configure -parameters javac option to configure IntelliJ IDEA.
• See Build and run the application to run an example from IntelliJ IDEA.

License

All files under this directory (examples) belong to the public domain. Please feel free to copy-and-paste and start your awesome project with Armeria!