Skip to content

Commit 61950bb

Browse files
authored
Refactor API security considerations in README
Removed API security considerations section and moved recommendations to the Security Consideration section.
1 parent 44b5de7 commit 61950bb

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,6 @@ No third-party dependencies are currently used.
5656
- OpenWeather is used as an external HTTP API, not as a bundled SDK.
5757
- If cross-cutting tooling is added later, it must stay limited to concerns such as linting, logging, or CI support.
5858

59-
## API Security Considerations
60-
61-
For a production API setup, the app should be backed by additional security controls rather than relying only on a client-side request flow.
62-
63-
Recommended measures include:
64-
65-
- rate limiting to reduce abuse and protect the weather service integration
66-
- server-side API key protection instead of exposing sensitive keys in client builds
67-
- request validation and monitoring for suspicious traffic patterns
68-
- logging and alerting around failed or excessive API usage
6959

7060
## Weather Presentation Mapping
7161

@@ -479,3 +469,10 @@ If GitHub Actions shows JavaScript runtime warnings such as Node 20 deprecation
479469
## Security Consideration
480470

481471
The API key is stored on the client side, which is unsecure, and any bad actors can unbundle the app and gain access to the API key. This is only for testing purposes. If the app was to be mass distributed, the API key would be moved to Firebase Secrets Manager.
472+
473+
Recommended measures include:
474+
475+
- rate limiting to reduce abuse and protect the weather service integration
476+
- server-side API key protection instead of exposing sensitive keys in client builds
477+
- request validation and monitoring for suspicious traffic patterns
478+
- logging and alerting around failed or excessive API usage

0 commit comments

Comments
 (0)