Update README.md

This commit is contained in:
Oleg Zhurakousky
2023-02-22 13:08:45 +01:00
parent d395ab8a8f
commit be1f2ebc2e

View File

@@ -3,13 +3,18 @@
This module represents a concept of a light weight AWS forwarding proxy which deploys and interacts with existing
Spring Boot web application deployed as AWS Lambda.
<<<<<<< HEAD
A sample is provided in `/sample` directory
=======
Classes in this package should ideally reside in spring-web somewhere as a light weight HTTP proxy, since they are independent of the
context of the execution (i.e., AWS or Azure or whatever).
In fact classes in these package is a slimed-down copy of similar classes in MockMVC.
>>>>>>> 1c2b20bc6 (Stopping point with initial POC)
=======
A sample is provided in `/sample` directory
>>>>>>> cde7aa2c7 (Docs)
A sample is provided in [sample](https://github.com/spring-cloud/spring-cloud-function/tree/serverless-web/spring-cloud-function-adapters/spring-cloud-function-adapter-aws-web/sample/pet-store) directory. It contain README and SAM template file to simplify the deployment. This module is identified as the only additional dependnecy to the existing web-app.
_NOTE: Although this module is AWS specific, this dependency is protocol only (not binary), therefore there is no AWS dependnecies._
The aformentioned proxy is identified as AWS Lambda [handler](https://github.com/spring-cloud/spring-cloud-function/blob/serverless-web/spring-cloud-function-adapters/spring-cloud-function-adapter-aws-web/sample/pet-store/template.yml#L14)
The main Spring Boot configuration file is identified as [MAIN_CLASS](https://github.com/spring-cloud/spring-cloud-function/blob/serverless-web/spring-cloud-function-adapters/spring-cloud-function-adapter-aws-web/sample/pet-store/template.yml#L22)