aws / aws/serverless-java-container
Provide concrete example of building custom events
- Ngôn ngữ chính
- Java
- Star
- 1.6k
- Fork
- 574
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
*To help us debug your issue fill in the basic information below using the options provided*
*Serverless Java Container version*: `eg. 1.5`
v1 (Spring Boot 2) and v2 (Spring Boot 3.x)
*Implementations:* `Jersey / Spring / Spring Boot / Spring Boot 2 / Spark`
Spring Boot
*Framework version:* `eg SpringBoot 2.2.6.RELEASE`
Spring Boot 2.x and Spring Boot 3.x
*Frontend service:* `REST API / HTTP API / ALB`
VPC Lattice
*Deployment method:* `eg SAM, Serverless Framework, Console`
N/A
## Scenario
*Describe what you are trying to accomplish*
This is a more general ask related to this [issue](https://github.com/awslabs/aws-serverless-java-container/issues/639). The documentation provided [here](https://github.com/awslabs/aws-serverless-java-container/wiki/Custom-event-types) indicates that just four classes need to be implemented to build the custom class. However, pursuant of trying to implement the VPC Lattice event, I discovered that in addition to creating the POJOs for the event model itself, I needed to also implement `ExceptionHandler`, `SecurityContext`, `SecurityContextWriter`. It would helpful to include a practical example of how to create the custom event, outline the minimum and optional attributes for the servlet request, and how to set fields for the response payload.
## Expected behavior
*Describe how you would expect the application to behave*
Ability to simply or at least clear extend the framework with custom event payloads
## Actual behavior
*Describe what you are seeing instead*
Difficulty following the documentation
Hướng dẫn đóng góp
Hướng nghiên cứu
Bắt đầu với trang wiki Custom-event-types hiện có và issue 639 liên quan, sau đó so sánh hướng dẫn về bốn lớp trong đó với các yêu cầu bổ sung đối với ExceptionHandler, SecurityContext và SecurityContextWriter được mô tả ở đây. Công việc được xem là hoàn tất khi tài liệu bao gồm một ví dụ thực tế về custom-event, xác định các thuộc tính servlet-request tối thiểu và tùy chọn, đồng thời giải thích cách các trường response được điền.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- java, spring-boot
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100