Skip to content

Commit 27ce0d1

Browse files
committed
chore: rename package to hello-fastapi and improve readme with exposed endpoints
1 parent 99a8c45 commit 27ce0d1

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
# hello-python-fastapi
1+
# hello-fastapi
22

3-
Python FastAPI Hello App
3+
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.
410

511
# Setup
612

@@ -19,6 +25,6 @@ uvicorn main:app --port 5001 --reload
1925
Bulild and run via docker:
2026

2127
```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
2430
```

0 commit comments

Comments
 (0)