Skip to content

Commit

Permalink
Merge pull request #3 from vladNed/docs/add-credits-to-docs
Browse files Browse the repository at this point in the history
Add credits to docs
  • Loading branch information
vladNed authored Sep 14, 2024
2 parents 7d008a9 + 4640e68 commit 49cfa15
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 5 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
This is a file-based router for FastAPI that automatically discovers and registers route files based on their filenames.
This tool simplifies the organization and scaling of your FastAPI projects by allowing you to structure your endpoints in a modular way.
With `fastapi-endpoints`, you can easily manage complex applications by keeping your routes clean, intuitive, and maintainable.
This project is inspired from [SettleAPI/settle-fastapi-extensions](https://github.com/SettleAPI/settle-fastapi-extensions)

Please refer to the documentation here:

Expand Down
2 changes: 1 addition & 1 deletion docs/exclude-routers.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can exclude routers from being registered by the router by defining the `EXC
For example, if you have the following directory structure:
```
routers
|── __init__.py
── __init__.py
├── api_v1
│ ├── __init__.py
│ ├── users.py
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The project structure should contain the directory `routers/`, for example this:

```bash hl_lines="1"
routers
|── __init__.py
── __init__.py
├── api_v1
│ ├── __init__.py
│ ├── users.py
Expand Down Expand Up @@ -102,7 +102,7 @@ In this example, the `routers/dev/posts.py` router will be excluded.

``` hl_lines="7 8 9"
routers
|── __init__.py
── __init__.py
├── api_v1
│ ├── __init__.py
│ ├── users.py
Expand Down
4 changes: 2 additions & 2 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ First, be sure you have a python environment created and activated.
Create a project with the following structure:
```
routers
|── items.py
── items.py
└── __init__.py
app.py
__init__.py
Expand Down Expand Up @@ -57,7 +57,7 @@ An example of an existing project structure:

```
routers
|── items.py
── items.py
└── __init__.py
app.py
__init__.py
Expand Down

0 comments on commit 49cfa15

Please sign in to comment.