Skip to content

n-strong/SurfWeb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

                                            Surf Forecast Microservice README

Overview: This microservice provides surf forecast info and sends it to a specified email address upon request. It's designed to be used programmatically through HTTP requests, making it a versatile component for web applications related to surf conditions and weather forecasting.

                                                Communication Contract

Requesting Data: To request surf forecast data to be sent via email, make a POST request to the /send_forecast endpoint. The request should include form data with two fields: email (the recipient's email address) and surf_forecast (the forecast information you wish to send).

Example Call Using Python's requests library:

================================================================================================================================================= import requests

url = 'http://:/send_forecast' data = { 'email': '[email protected]', 'surf_forecast': 'Sunny with waves 3-5 feet' }

response = requests.post(url, data=data) print(response.text)

Replace and with your server's domain name or IP address and the port where the Flask application is running. For this project = 127.0.0.1 & = 333

Receiving Data: Upon successfully sending the email, the microservice will respond with a JSON object containing a success message.

Example Response:

======================================== { "message": "Email sent successfully!" }

                                                        UML Sequence Diagram

Microservice UML