Skip to content

Commit

Permalink
add detail to API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
benpaddlejones committed Oct 3, 2024
1 parent 5cd1a28 commit 87c1989
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .studentResources/safe_API/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ This example safe API is a basic implementaion for a random movie generator. The

Too allow cross origins you need to install flask CORS library.

> [!IMPORTANT]
> This is an example of how to create a secure API in a development environment, a secure public API would have the following additional features:
>
> - HTTPS encrytion
> - A CSP policy that enforces HTTPS for all communication
> - API rate limits, for example [Flask Limiter](https://flask-limiter.readthedocs.io/en/stable/)
> - Detailed logging of all POST and GET requests for security analysis
```bash
pip install flask_cors
```
Expand Down

0 comments on commit 87c1989

Please sign in to comment.