You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-13Lines changed: 12 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,8 +20,8 @@
20
20
21
21
22
22
-[Introduction](#introduction)
23
-
-[Advantage](#advantage)
24
-
-[Constraint](#constraint)
23
+
-[Advantages](#advantages)
24
+
-[Limitations](#limitations)
25
25
-[Getting started](#getting-started)
26
26
-[Installation](#installation)
27
27
-[Usage](#usage)
@@ -38,9 +38,9 @@
38
38
39
39
# Introduction
40
40
41
-
I believe that everyone who's working with FastApi and building some RESTful of CRUD services, wastes the time to writing similar code for simple CRUD every time
41
+
I believe that many people who work with FastApi to build RESTful CRUD services end up wasting time writing repitive boilerplate code.
42
42
43
-
`FastAPI Quick CRUD` can generate CRUD in FastApi with SQLAlchemy schema
43
+
`FastAPI Quick CRUD` can generate CRUD methods in FastApi from an SQLAlchemy schema:
44
44
45
45
- Get one
46
46
- Get many
@@ -58,9 +58,9 @@ I believe that everyone who's working with FastApi and building some RESTful of
-[x]**Support SQLAlchemy 1.4** - Allow you build a fully asynchronous python service, also supports synchronization.
63
+
-[x]**Support SQLAlchemy 1.4** - Allows you build a fully asynchronous or synchronous python service
64
64
65
65
-[x]**Full SQLAlchemy DBAPI Support** - Support different SQL for SQLAlchemy
66
66
@@ -74,11 +74,11 @@ I believe that everyone who's working with FastApi and building some RESTful of
74
74
75
75
-[x]**SQL Relationship** - `FIND ONE/MANY` supports Path get data with relationship
76
76
77
-
## Constraint
77
+
## Limitations
78
78
79
79
- ❌ If there are multiple **unique constraints**, please use **composite unique constraints** instead
80
-
- ❌ **Composite primary key** is not support
81
-
- ❌ Not Support API requests with specific resource`xxx/{primary key}`when table have not primary key;
80
+
- ❌ **Composite primary key** is not supported
81
+
- ❌ Unsupported API requests with on resources`xxx/{primary key}`for tables without a primary key;
82
82
-`UPDATE ONE`
83
83
-`FIND ONE`
84
84
-`PATCH ONE`
@@ -88,8 +88,7 @@ I believe that everyone who's working with FastApi and building some RESTful of
88
88
# Getting started
89
89
90
90
##
91
-
Welcome if you can accept the dependency version
92
-
I will take the time to update the version dependencies as soon as possible to ensure that the core dependencies of this project have the highest version
91
+
I try to update the version dependencies as soon as possible to ensure that the core dependencies of this project have the highest version possible.
93
92
```bash
94
93
fastapi<=0.68.2
95
94
pydantic<=1.8.2
@@ -111,7 +110,7 @@ pip install asyncpg
111
110
112
111
## Usage
113
112
114
-
### Simple Code (get more example from ([example](https://github.com/LuisLuii/FastAPIQuickCRUD/blob/main/tutorial/sample.py))
113
+
### Simple Code (or see the longer ([example](https://github.com/LuisLuii/FastAPIQuickCRUD/blob/main/tutorial/sample.py))
you can use [sqlacodegen](https://github.com/agronholm/sqlacodegen) to generate SQLAlchemy model for your table. This project is based on the model development and testing generated by sqlacodegen
216
+
you can use [sqlacodegen](https://github.com/agronholm/sqlacodegen) to generate SQLAlchemy models for your table. This project is based on the model development and testing generated by sqlacodegen
0 commit comments