We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 99a8c45 commit 27ce0d1Copy full SHA for 27ce0d1
README.md
@@ -1,6 +1,12 @@
1
-# hello-python-fastapi
+# hello-fastapi
2
3
-Python FastAPI Hello App
+Hello FastAPI is a tiny web server that responds to a GET request with a JSON response.
4
+
5
+It exposes the following endpoints:
6
7
+- `/api` - returns a JSON response with a message "Hello, FastAPI!", env vars starting with `HELLO_` and request headers.
8
+- `/docs` - FastAPI's auto-generated API documentation.
9
+- `/openapi.json` - FastAPI's auto-generated OpenAPI schema.
10
11
# Setup
12
@@ -19,6 +25,6 @@ uvicorn main:app --port 5001 --reload
19
25
Bulild and run via docker:
20
26
21
27
```bash
22
-docker build -t hello-python-fastapi .
23
-docker run --rm -p 5001:8000 hello-python-fastapi
28
+docker build -t hello-fastapi .
29
+docker run --rm -p 5001:8000 hello-fastapi
24
30
```
0 commit comments