Skip to content

Commit b5ca5dd

Browse files
committed
[TEMPLATE] update README of fastapi-default template
1 parent 06458fc commit b5ca5dd

2 files changed

Lines changed: 15 additions & 4 deletions

File tree

src/fastapi_fastkit/cli.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,6 @@ def runserver(
400400
) -> None:
401401
"""
402402
Run the FastAPI server for the current project.
403-
[1.1.0 update TODO] Alternative Point : using FastAPI-fastkit's 'fastapi dev' command
404403
405404
:param ctx: Click context object
406405
:param host: Host address to bind the server to

src/fastapi_fastkit/fastapi_project_template/fastapi-default/README.md-tpl

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,34 @@ Simple CRUD API application using FastAPI
44

55
## Features
66

7-
- Item Creation, Read, Update, Delete (CRUD) functionality
7+
- Item Creation, Read, Update, Delete (CRUD) functionality (For Demo)
88
- Automatic OpenAPI documentation generation (Swagger UI, ReDoc)
99
- Test environment with mock data
1010

1111
## Stack
1212

1313
- Python 3.12+
1414
- FastAPI + uvicorn
15-
- pydantic & pydantic-settings
15+
- pydantic 2 & pydantic-settings
1616
- pytest
1717
- mypy + black + isort
1818

1919
## How to run
2020

21-
at venv, run command below:
21+
At venv, run command below:
2222

2323
```bash
2424
$ uvicorn src.main:app --reload
2525
```
26+
27+
After running server instance, you can check API documentation below:
28+
29+
```bash
30+
<domain>/docs # Swagger format
31+
<domain>/redoc # ReDoc format
32+
33+
# example
34+
http://127.0.0.1/docs
35+
```
36+
37+
For other FastAPI guides, please refer <https://fastapi.tiangolo.com/tutorial/>

0 commit comments

Comments
 (0)