Package akka.javasdk.annotations.http

Annotation Interface Put

@Target(METHOD) @Retention(RUNTIME) @Documented public @interface Put
Annotation to mark a method as handling HTTP PUT requests.

PUT requests are used to create or completely replace a resource at a specific location. They should be idempotent, meaning multiple identical requests should have the same effect.

Path Configuration: The annotation value specifies the path pattern for this endpoint, which is combined with the HttpEndpoint class-level path prefix to form the complete URL.

Request Bodies: PUT methods typically include request bodies with the complete resource representation that should replace the existing resource. The request body parameter must come last in the parameter list when combined with path parameters.

Path Parameters: Use {paramName} in the path to identify the specific resource to create or update. These can be combined with request body parameters.

Response Types: PUT methods typically return the updated resource, a success confirmation, or appropriate status codes (200 OK for updates, 201 Created for new resources).

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    value
     

  • Element Details

    • value

      String value
      Default:
      ""