Compare commits

...

12 Commits

Author SHA1 Message Date
Sebastián Ramírez
08484603ee 🔖 Release 0.14.0 2019-04-12 21:56:22 +04:00
Sebastián Ramírez
ab6dd60997 📝 Add note on installing and running pytest 2019-04-12 21:45:19 +04:00
Sebastián Ramírez
c9ef7bd6dc 📝 Update release notes 2019-04-12 21:27:24 +04:00
Sebastián Ramírez
88ece95a30 🎨 Improve automatic naming of path operations in API docs (#155)
* 🎨 Improve operation summary naming

* 📝 Update names in README

* 🚚 Improve names of security tutorial
2019-04-12 21:25:26 +04:00
Sebastián Ramírez
366c5db0bb 📝 Update release notes 2019-04-12 20:18:48 +04:00
Sebastián Ramírez
46e3811f8d Add testing docs and tests (#151)
* ✏️ Fix typo in security intro

*  Add testing docs and tests

* 🐛 Debug Travis coverage

* 🐛 Debug Travis coverage, report XML

* 💚 Make Travis/Flit use same code install

*  Revert Travis/Codecov debugging changes
2019-04-12 20:15:05 +04:00
Sebastián Ramírez
613e211d20 📝 Update release notes 2019-04-12 11:51:26 +04:00
William Hayes
500f2b2ad4 Add deeplinking to Swagger UI (#148)
Update the Swagger UI docs to deep link to path operations to share them more easily.
2019-04-12 11:49:32 +04:00
Sebastián Ramírez
5cf7718657 📝 Update release notes 2019-04-12 11:40:56 +04:00
Sebastián Ramírez
727b656c8d ⬆️ Update development dependencies, Pipfile.lock (#150) 2019-04-12 11:39:06 +04:00
Sebastián Ramírez
cc7102e9b8 📝 Add opinions in main page 2019-04-10 22:27:28 +04:00
Sebastián Ramírez
5123915fe4 📝 Include Hug and Falcon in Alternatives/Inspiration 2019-04-10 22:09:50 +04:00
96 changed files with 550 additions and 208 deletions

View File

@@ -10,7 +10,7 @@ python:
install:
- pip install flit
- flit install
- flit install --symlink
script:
- bash scripts/test.sh

119
Pipfile.lock generated
View File

@@ -18,34 +18,33 @@
"default": {
"aiocontextvars": {
"hashes": [
"sha256:1e0ff5837c8b01c36a1107acdd0baf7853ebdf6c9fc43e8e311f4be37ac2038a",
"sha256:6ff7aee14f549d52f0446cbb84d0deddcd3fc677bcf8fbc2ce13f5756d2064dc"
"sha256:885daf8261818767d8f7cbd79f9d4482d118f024b6586ef6e67980236a27bfa3",
"sha256:f027372dc48641f683c559f247bd84962becaacdc9ba711d583c3871fb5652aa"
],
"markers": "python_version < '3.7'",
"version": "==0.2.1"
"version": "==0.2.2"
},
"aiosqlite": {
"hashes": [
"sha256:af4fed9e778756fa0ffffc7a8b14c4d7b1a57155dc5669f18e45107313f6019e"
"sha256:ad84fbd7516ca7065d799504fc41d6845c938e5306d1b7dd960caaeda12e22a9"
],
"version": "==0.9.0"
"version": "==0.10.0"
},
"contextvars": {
"hashes": [
"sha256:2341042e1c03a271813e07dba29b6b60fa85c1005ea5ed1638a076cf50b4d625"
"sha256:f38c908aaa59c14335eeea12abea5f443646216c4e29380d7bf34d2018e2c39e"
],
"markers": "python_version < '3.7'",
"version": "==2.3"
"version": "==2.4"
},
"databases": {
"extras": [
"sqlite"
],
"hashes": [
"sha256:4a0f15669c390a04b439972426350c0ae921ddc08c42bd54f125eb2fb86ee728"
"sha256:da819f7e00dc7d8c2f0585ec53aa49bae63b366f800506097db2e87972a4d44f"
],
"index": "pypi",
"version": "==0.2.0"
"version": "==0.2.1"
},
"dataclasses": {
"hashes": [
@@ -57,19 +56,9 @@
},
"immutables": {
"hashes": [
"sha256:1e4f4513254ef11e0230a558ee0dcb4551b914993c330005d15338da595d3750",
"sha256:228e38dc7a810ba4ff88909908ac47f840e5dc6c4c0da6b25009c626a9ae771c",
"sha256:2ae88fbfe1d04f4e5859c924e97313edf70e72b4f19871bf329b96a67ede9ba0",
"sha256:2d32b61c222cba1dd11f0faff67c7fb6204ef1982454e1b5b001d4b79966ef17",
"sha256:35af186bfac5b62522fdf2cab11120d7b0547f405aa399b6a1e443cf5f5e318c",
"sha256:63023fa0cceedc62e0d1535cd4ca7a1f6df3120a6d8e5c34e89037402a6fd809",
"sha256:6bf5857f42a96331fd0929c357dc0b36a72f339f3b6acaf870b149c96b141f69",
"sha256:7bb1590024a032c7a57f79faf8c8ff5e91340662550d2980e0177f67e66e9c9c",
"sha256:7c090687d7e623d4eca22962635b5e1a1ee2d6f9a9aca2f3fb5a184a1ffef1f2",
"sha256:bc36a0a8749881eebd753f696b081bd51145e4d77291d671d2e2f622e5b65d2f",
"sha256:d9fc6a236018d99af6453ead945a6bb55f98d14b1801a2c229dd993edc753a00"
"sha256:f958ba15745e30d3a38e3c9fcead8496037135bb21c78c0f925c104abba3a6fa"
],
"version": "==0.6"
"version": "==0.9"
},
"pydantic": {
"hashes": [
@@ -81,9 +70,9 @@
},
"sqlalchemy": {
"hashes": [
"sha256:781fb7b9d194ed3fc596b8f0dd4623ff160e3e825dd8c15472376a438c19598b"
"sha256:d5432832f91d200c3d8b473a266d59442d825f9ea744c467e68c5d9a9479fbce"
],
"version": "==1.3.1"
"version": "==1.3.2"
},
"starlette": {
"hashes": [
@@ -317,11 +306,11 @@
},
"isort": {
"hashes": [
"sha256:08f8e3f0f0b7249e9fad7e5c41e2113aba44969798a26452ee790c06f155d4ec",
"sha256:4e9e9c4bd1acd66cf6c36973f29b031ec752cbfd991c69695e4e259f9a756927"
"sha256:01cb7e1ca5e6c5b3f235f0385057f70558b70d2f00320208825fa62887292f43",
"sha256:268067462aed7eb2a1e237fcb287852f22077de3fb07964e87e00f829eea2d1a"
],
"index": "pypi",
"version": "==4.3.16"
"version": "==4.3.17"
},
"jedi": {
"hashes": [
@@ -332,10 +321,10 @@
},
"jinja2": {
"hashes": [
"sha256:74c935a1b8bb9a3947c50a54766a969d4846290e1e788ea44c1392163723c3bd",
"sha256:f84be1bb0040caca4cea721fcbbbbd61f9be9464ca236387158b0feea01914a4"
"sha256:065c4f02ebe7f7cf559e49ee5a95fb800a9e4528727aec6f24402a5374c65013",
"sha256:14dd6caf1527abb21f08f86c784eac40853ba93edb79552aa1e4b8aef1b61c7b"
],
"version": "==2.10"
"version": "==2.10.1"
},
"jsonschema": {
"hashes": [
@@ -383,10 +372,10 @@
},
"markdown": {
"hashes": [
"sha256:c00429bd503a47ec88d5e30a751e147dcb4c6889663cd3e2ba0afe858e009baa",
"sha256:d02e0f9b04c500cde6637c11ad7c72671f359b87b9fe924b2383649d8841db7c"
"sha256:fc4a6f69a656b8d858d7503bda633f4dd63c2d70cf80abdc6eafa64c4ae8c250",
"sha256:fe463ff51e679377e3624984c829022e2cfb3be5518726b06f608a07a3aad680"
],
"version": "==3.0.1"
"version": "==3.1"
},
"markdown-include": {
"hashes": [
@@ -452,27 +441,36 @@
},
"mkdocs-material": {
"hashes": [
"sha256:0b394aa034b25a09a5874ae2a6ccc426fd81f5764e0991217b169e31cb0c1c0e",
"sha256:f5bb80a2c16d045d380edb2c5b05636af1bb709cb859bfaa9d01063a11df803f"
"sha256:8f0a5217c24bd8635c0bda2a0ee4f91766448e9e3dd6429f1111dd992327345e",
"sha256:c2c6ef6b3e3ab4744a45d03a276e1eb106c91abf610d180d148613fd1a525c7c"
],
"index": "pypi",
"version": "==4.1.0"
"version": "==4.1.1"
},
"more-itertools": {
"hashes": [
"sha256:0125e8f60e9e031347105eb1682cef932f5e97d7b9a1a28d9bf00c22a5daef40",
"sha256:590044e3942351a1bdb1de960b739ff4ce277960f2425ad4509446dbace8d9d1"
"sha256:2112d2ca570bb7c3e53ea1a35cd5df42bb0fd10c45f0fb97178679c3c03d64c7",
"sha256:c3e4748ba1aad8dba30a4886b0b1a2004f9a863837b8654e7059eebf727afa5a"
],
"markers": "python_version > '2.7'",
"version": "==6.0.0"
"version": "==7.0.0"
},
"mypy": {
"hashes": [
"sha256:308c274eb8482fbf16006f549137ddc0d69e5a589465e37b99c4564414363ca7",
"sha256:e80fd6af34614a0e898a57f14296d0dacb584648f0339c2e000ddbf0f4cc2f8d"
"sha256:03261a04ace27250cf14f1301969e2cc36ad0343dd437e60007ce42f06ddbaff",
"sha256:6a7923e90dd8f8b8e762327e3a4dd814f0bc5581a627010f4e2ec72d906ada0f",
"sha256:6a7c2b16ff7dee1cd4a913641d6a8da0cd386be812524f41427ea25f8fe337a6",
"sha256:7480db0bc2bb473547c8d519ea549de9f9654170e6f5b34310094ebe5ee1c9dc",
"sha256:863774c896f2cdc62a0e2252e9ba7aaeb7da04c0296f47c82b125dce3437c580",
"sha256:9a990cf039891a83ee90f130256cc06d09c0793242ea38d0fe33fdc449507123",
"sha256:b03573d0cd8c051aa9ef7f47d564cf44bbc5e91e89a7a078b3ca904b3da8855a",
"sha256:b10b16d9aa7a01266f14260344fb25849ef0d508c512a916043f77987489aeff",
"sha256:b1eab82221c3cc94bf22152e701b3efc9d64f60fac4cab20969a0427e5a78261",
"sha256:e663d4424531dc99fb85c947df8a4a107442f53f20a4e0bcefaa1d21c87e1563",
"sha256:ffac30f3fa2c9e10118cbb0faa0b7da7edb6e3c24a4048a15446a1f3409884e3"
],
"index": "pypi",
"version": "==0.670"
"version": "==0.700"
},
"mypy-extensions": {
"hashes": [
@@ -497,10 +495,10 @@
},
"notebook": {
"hashes": [
"sha256:18a98858c0331fb65a60f2ebb6439f8c0c4defd14ca363731b6cabc7f61624b4",
"sha256:cc027a62be0f7756e0ef3d2d98458c4d7f4b3566449fb1a05891207f5bd9a1bf"
"sha256:573e0ae650c5d76b18b6e564ba6d21bf321d00847de1d215b418acb64f056eb8",
"sha256:f64fa6624d2323fbef6210a621817d6505a45d0d4a9367f1843b20a38a4666ee"
],
"version": "==5.7.6"
"version": "==5.7.8"
},
"pandocfilters": {
"hashes": [
@@ -510,18 +508,17 @@
},
"parso": {
"hashes": [
"sha256:4580328ae3f548b358f4901e38c0578229186835f0fa0846e47369796dd5bcc9",
"sha256:68406ebd7eafe17f8e40e15a84b56848eccbf27d7c1feb89e93d8fca395706db"
"sha256:17cc2d7a945eb42c3569d4564cdf49bde221bc2b552af3eca9c1aad517dcdd33"
],
"version": "==0.3.4"
"version": "==0.4.0"
},
"pexpect": {
"hashes": [
"sha256:2a8e88259839571d1251d278476f3eec5db26deb73a70be5ed5dc5435e418aba",
"sha256:3fbd41d4caf27fa4a377bfd16fef87271099463e6fa73e92a52f92dfee5d425b"
"sha256:2094eefdfcf37a1fdbfb9aa090862c1a4878e5c7e0e7e7088bdb511c558e5cd1",
"sha256:9e2c1fd0e6ee3a49b28f95d4b33bc389c89b20af6a1255906e90ff1262ce62eb"
],
"markers": "sys_platform != 'win32'",
"version": "==4.6.0"
"version": "==4.7.0"
},
"pickleshare": {
"hashes": [
@@ -602,11 +599,11 @@
},
"pytest": {
"hashes": [
"sha256:592eaa2c33fae68c7d75aacf042efc9f77b27c08a6224a4f59beab8d9a420523",
"sha256:ad3ad5c450284819ecde191a654c09b0ec72257a2c711b9633d677c71c9850c4"
"sha256:13c5e9fb5ec5179995e9357111ab089af350d788cbc944c628f3cde72285809b",
"sha256:f21d2f1fb8200830dcbb5d8ec466a9c9120e20d8b53c7585d180125cce1d297a"
],
"index": "pypi",
"version": "==4.3.1"
"version": "==4.4.0"
},
"pytest-cov": {
"hashes": [
@@ -713,16 +710,16 @@
},
"sqlalchemy": {
"hashes": [
"sha256:781fb7b9d194ed3fc596b8f0dd4623ff160e3e825dd8c15472376a438c19598b"
"sha256:d5432832f91d200c3d8b473a266d59442d825f9ea744c467e68c5d9a9479fbce"
],
"version": "==1.3.1"
"version": "==1.3.2"
},
"terminado": {
"hashes": [
"sha256:55abf9ade563b8f9be1f34e4233c7b7bde726059947a593322e8a553cc4c067a",
"sha256:65011551baff97f5414c67018e908110693143cfbaeb16831b743fe7cad8b927"
"sha256:d9d012de63acb8223ac969c17c3043337c2fcfd28f3aea1ee429b345d01ef460",
"sha256:de08e141f83c3a0798b050ecb097ab6259c3f0331b2f7b7750c9075ced2c20c2"
],
"version": "==0.8.1"
"version": "==0.8.2"
},
"testpath": {
"hashes": [
@@ -797,10 +794,10 @@
},
"uvicorn": {
"hashes": [
"sha256:d700b65169820fc260f39402b7f966c178691daaa40cb376cad99d7cd737f772"
"sha256:d96fb442d9ce9c1dba67360035161d392970b8e6b0ed797d2cefed24abfd78bc"
],
"index": "pypi",
"version": "==0.7.0b1"
"version": "==0.7.0b2"
},
"uvloop": {
"hashes": [

View File

@@ -43,6 +43,28 @@ The key features are:
<small>* estimation based on tests on an internal development team, building production applications.</small>
## Opinions
"*[...] I'm using **FastAPI** a ton these days. [...] I'm actually planning to use it for all of my team's **ML services at Microsoft**. Some of them are getting integrated into the core **Windows** product and some **Office** products.*"
<div style="text-align: right; margin-right: 10%;">Kabir Khan - <strong>Microsoft</strong> <a href="https://github.com/tiangolo/fastapi/pull/26" target="_blank"><small>(ref)</small></a></div>
---
"*Im over the moon excited about **FastAPI**. Its so fun!*"
<div style="text-align: right; margin-right: 10%;">Brian Okken - <strong><a href="https://pythonbytes.fm/episodes/show/123/time-to-right-the-py-wrongs?time_in_sec=855" target="_blank">Python Bytes</a> podcast host</strong> <a href="https://twitter.com/brianokken/status/1112220079972728832" target="_blank"><small>(ref)</small></a></div>
---
"*Honestly, what you've built looks super solid and polished. In many ways, it's what I wanted **Hug** to be - it's really inspiring to see someone build that.*"
<div style="text-align: right; margin-right: 10%;">Timothy Crosley - <strong><a href="http://www.hug.rest/" target="_blank">Hug</a> creator</strong> <a href="https://news.ycombinator.com/item?id=19455465" target="_blank"><small>(ref)</small></a></div>
---
## Requirements
@@ -198,7 +220,7 @@ def read_item(item_id: int, q: str = None):
@app.put("/items/{item_id}")
def create_item(item_id: int, item: Item):
def update_item(item_id: int, item: Item):
return {"item_name": item.name, "item_id": item_id}
```

View File

@@ -236,6 +236,19 @@ It was one of the first extremely fast Python frameworks based on `asyncio`. It
That's why **FastAPI** is based on Starlette, as it is the fastest framework available (tested by third-party benchmarks).
### <a href="https://falconframework.org/" target="_blank">Falcon</a>
Falcon is another high performance Python framework, it is designed to be minimal, and work as the foundation of other frameworks like Hug.
It uses the previous standard for Python web frameworks (WSGI) which is synchronous, so it can't handle Websockets and other use cases. Nevertheless, it also has a very good performance.
It is designed to have functions that receive two parameters, one "request" and one "response". Then you "read" parts from the request, and "write" parts to the response. Because of this design, it is not possible to declare request parameters and bodies with standard Python type hints as function parameters.
So, data validation, serialization, and documentation, have to be done in code, not automatically. Or they have to be implemented as a framework on top of Falcon, like Hug. This same distinction happens in other frameworks that are inspired by Falcon's design, of having one request object and one response object as parameters.
!!! check "Inspired **FastAPI** to"
Find ways to get great performance.
### <a href="https://moltenframework.com/" target="_blank">Molten</a>
I discovered Molten in the first stages of building **FastAPI**. And it has quite similar ideas:
@@ -257,11 +270,34 @@ Routes are declared in a single place, using functions declared in other places
This actually inspired updating parts of Pydantic, to support the same validation declaration style (all this functionality is now already available in Pydantic).
### <a href="http://www.hug.rest/" target="_blank">Hug</a>
Hug was one of the first frameworks to implement the declaration of API parameter types using Python type hints. This was a great idea that inspired other tools to do the same.
It used custom types in its declarations instead of standard Python types, but it was still a huge step forward.
It also was one of the first frameworks to generate a custom schema declaring the whole API in JSON.
It was not based on a standard like OpenAPI and JSON Schema. So it wouldn't be straightforward to integrate it with other tools, like Swagger UI. But again, it was a very innovative idea.
It has an interesting, uncommon feature: using the same framework, it's possible to create APIs and also CLIs.
As it is based on the previous standard for synchronous Python web frameworks (WSGI), it can't handle Websockets and other things, although it still has high performance too.
!!! info
Hug was created by Timothy Crosley, the same creator of <a href="https://github.com/timothycrosley/isort" target="_blank">`isort`</a>, a great tool to automatically sort imports in Python files.
!!! check "Ideas inspired in **FastAPI**"
Hug inspired parts of APIStar, and was one of the tools I found most promising, alongside APIStar.
Hug helped inspiring **FastAPI** to use Python type hints to declare parameters, and to generate a schema defining the API automatically.
### <a href="https://github.com/encode/apistar" target="_blank">APIStar</a> (<= 0.5)
Right before deciding to build **FastAPI** I found **APIStar** server. It had almost everything I was looking for and had a great design.
It was actually the first implementation of a framework using Python type hints to declare parameters and requests that I ever saw (before NestJS and Molten).
It was one of the first implementations of a framework using Python type hints to declare parameters and requests that I ever saw (before NestJS and Molten). I found it more or less at the same time as Hug. But APIStar used the OpenAPI standard.
It had automatic data validation, data serialization and OpenAPI schema generation based on the same type hints in several places.

View File

@@ -43,6 +43,28 @@ The key features are:
<small>* estimation based on tests on an internal development team, building production applications.</small>
## Opinions
"*[...] I'm using **FastAPI** a ton these days. [...] I'm actually planning to use it for all of my team's **ML services at Microsoft**. Some of them are getting integrated into the core **Windows** product and some **Office** products.*"
<div style="text-align: right; margin-right: 10%;">Kabir Khan - <strong>Microsoft</strong> <a href="https://github.com/tiangolo/fastapi/pull/26" target="_blank"><small>(ref)</small></a></div>
---
"*Im over the moon excited about **FastAPI**. Its so fun!*"
<div style="text-align: right; margin-right: 10%;">Brian Okken - <strong><a href="https://pythonbytes.fm/episodes/show/123/time-to-right-the-py-wrongs?time_in_sec=855" target="_blank">Python Bytes</a> podcast host</strong> <a href="https://twitter.com/brianokken/status/1112220079972728832" target="_blank"><small>(ref)</small></a></div>
---
"*Honestly, what you've built looks super solid and polished. In many ways, it's what I wanted **Hug** to be - it's really inspiring to see someone build that.*"
<div style="text-align: right; margin-right: 10%;">Timothy Crosley - <strong><a href="http://www.hug.rest/" target="_blank">Hug</a> creator</strong> <a href="https://news.ycombinator.com/item?id=19455465" target="_blank"><small>(ref)</small></a></div>
---
## Requirements
@@ -198,7 +220,7 @@ def read_item(item_id: int, q: str = None):
@app.put("/items/{item_id}")
def create_item(item_id: int, item: Item):
def update_item(item_id: int, item: Item):
return {"item_name": item.name, "item_id": item_id}
```

View File

@@ -1,5 +1,17 @@
## Next release
## 0.14.0
* Improve automatically generated names of path operations in OpenAPI (in API docs). A function `read_items` instead of having a generated name "Read Items Get" will have "Read Items". PR <a href="https://github.com/tiangolo/fastapi/pull/155" target="_blank">#155</a>.
* Add docs for: <a href="https://fastapi.tiangolo.com/tutorial/testing/" target="_blank">Testing **FastAPI**</a>. PR <a href="https://github.com/tiangolo/fastapi/pull/151" target="_blank">#151</a>.
* Update `/docs` Swagger UI to enable deep linking. This allows sharing the URL pointing directly to the path operation documentation in the docs. PR <a href="https://github.com/tiangolo/fastapi/pull/148" target="_blank">#148</a> by <a href="https://github.com/wshayes" target="_blank">@wshayes</a>.
* Update development dependencies, `Pipfile.lock`. PR <a href="https://github.com/tiangolo/fastapi/pull/150" target="_blank">#150</a>.
* Include Falcon and Hug in: <a href="https://fastapi.tiangolo.com/alternatives/" target="_blank">Alternatives, Inspiration and Comparisons</a>.
## 0.13.0
* Improve/upgrade OAuth2 scopes support with `SecurityScopes`:

View File

View File

@@ -0,0 +1,8 @@
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def read_main():
return {"msg": "Hello World"}

View File

@@ -0,0 +1,11 @@
from starlette.testclient import TestClient
from .main import app
client = TestClient(app)
def test_read_main():
response = client.get("/")
assert response.status_code == 200
assert response.json() == {"msg": "Hello World"}

View File

@@ -0,0 +1,18 @@
from fastapi import FastAPI
from starlette.testclient import TestClient
app = FastAPI()
@app.get("/")
async def read_main():
return {"msg": "Hello World"}
client = TestClient(app)
def test_read_main():
response = client.get("/")
assert response.status_code == 200
assert response.json() == {"msg": "Hello World"}

View File

@@ -0,0 +1,31 @@
from fastapi import FastAPI
from starlette.testclient import TestClient
from starlette.websockets import WebSocket
app = FastAPI()
@app.get("/")
async def read_main():
return {"msg": "Hello World"}
@app.websocket_route("/ws")
async def websocket(websocket: WebSocket):
await websocket.accept()
await websocket.send_json({"msg": "Hello WebSocket"})
await websocket.close()
def test_read_main():
client = TestClient(app)
response = client.get("/")
assert response.status_code == 200
assert response.json() == {"msg": "Hello World"}
def test_websocket():
client = TestClient(app)
with client.websocket_connect("/ws") as websocket:
data = websocket.receive_json()
assert data == {"msg": "Hello WebSocket"}

View File

@@ -0,0 +1,24 @@
from fastapi import FastAPI
from starlette.testclient import TestClient
app = FastAPI()
items = {}
@app.on_event("startup")
async def startup_event():
items["foo"] = {"name": "Fighters"}
items["bar"] = {"name": "Tenders"}
@app.get("/items/{item_id}")
async def read_items(item_id: str):
return items[item_id]
def test_read_items():
with TestClient(app) as client:
response = client.get("/items/foo")
assert response.status_code == 200
assert response.json() == {"name": "Fighters"}

View File

@@ -12,5 +12,5 @@ async def startup_event():
@app.get("/items/{item_id}")
async def read_item(item_id: str):
async def read_items(item_id: str):
return items[item_id]

View File

@@ -6,7 +6,7 @@ items = {"foo": "The Foo Wrestlers"}
@app.get("/items/{item_id}")
async def create_item(item_id: str):
async def read_item(item_id: str):
if item_id not in items:
raise HTTPException(status_code=404, detail="Item not found")
return {"item": items[item_id]}

View File

@@ -6,7 +6,7 @@ items = {"foo": "The Foo Wrestlers"}
@app.get("/items-header/{item_id}")
async def create_item_header(item_id: str):
async def read_item_header(item_id: str):
if item_id not in items:
raise HTTPException(
status_code=404,

View File

@@ -112,7 +112,7 @@ async def get_current_active_user(current_user: User = Depends(get_current_user)
@app.post("/token", response_model=Token)
async def route_login_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
async def login_for_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
user = authenticate_user(fake_users_db, form_data.username, form_data.password)
if not user:
raise HTTPException(status_code=400, detail="Incorrect username or password")

View File

@@ -138,7 +138,7 @@ async def get_current_active_user(
@app.post("/token", response_model=Token)
async def route_login_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
async def login_for_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
user = authenticate_user(fake_users_db, form_data.username, form_data.password)
if not user:
raise HTTPException(status_code=400, detail="Incorrect username or password")

View File

@@ -20,7 +20,7 @@ It is quite an extensive specification and covers several complex use cases.
It includes ways to authenticate using a "third party".
That's what all the system with "login with Facebook, Google, Twitter, GitHub" use underneath.
That's what all the systems with "login with Facebook, Google, Twitter, GitHub" use underneath.
### OAuth 1

85
docs/tutorial/testing.md Normal file
View File

@@ -0,0 +1,85 @@
Thanks to <a href="https://www.starlette.io/testclient/" target="_blank">Starlette's TestClient</a>, testing **FastAPI** applications is easy and enjoyable.
It is based on <a href="http://docs.python-requests.org" target="_blank">Requests</a>, so it's very familiar and intuitive.
With it, you can use <a href="https://docs.pytest.org/" target="_blank">pytest</a> directly with **FastAPI**.
## Using `TestClient`
Import `TestClient` from `starlette.testclient`.
Create a `TestClient` passing to it your **FastAPI**.
Create functions with a name that starts with `test_` (this is standard `pytest` conventions).
Use the `TestClient` object the same way as you do with `requests`.
Write simple `assert` statements with the standard Python expressions that you need to check (again, standard `pytest`).
```Python hl_lines="2 12 15 16 17 18"
{!./src/app_testing/tutorial001.py!}
```
!!! tip
Notice that the testing functions are normal `def`, not `async def`.
And the calls to the client are also normal calls, not using `await`.
This allows you to use `pytest` directly without complications.
## Separating tests
In a real application, you probably would have your tests in a different file.
And your **FastAPI** application might also be composed of several files/modules, etc.
### **FastAPI** app file
Let's say you have a file `main.py` with your **FastAPI** app:
```Python
{!./src/app_testing/main.py!}
```
### Testing file
Then you could have a file `test_main.py` with your tests, and import your `app` from the `main` module (`main.py`):
```Python
{!./src/app_testing/test_main.py!}
```
## Testing WebSockets
You can use the same `TestClient` to test WebSockets.
For this, you use the `TestClient` in a `with` statement, connecting to the WebSocket:
```Python hl_lines="27 28 29 30 31"
{!./src/app_testing/tutorial002.py!}
```
## Testing Events, `startup` and `shutdown`
When you need your event handlers (`startup` and `shutdown`) to run in your tests, you can use the `TestClient` with a `with` statement:
```Python hl_lines="9 10 11 12 20 21 22 23 24"
{!./src/app_testing/tutorial003.py!}
```
## Run it
After that, you just need to install `pytest`:
```bash
pip install pytest
```
It will detect the files and tests automatically, execute them, and report the results back to you.
Run the tests with:
```bash
pytest
```

View File

@@ -1,6 +1,6 @@
"""FastAPI framework, high performance, easy to learn, fast to code, ready for production"""
__version__ = "0.13.0"
__version__ = "0.14.0"
from starlette.background import BackgroundTasks

View File

@@ -31,7 +31,8 @@ def get_swagger_ui_html(*, openapi_url: str, title: str) -> HTMLResponse:
SwaggerUIBundle.presets.apis,
SwaggerUIBundle.SwaggerUIStandalonePreset
],
layout: "BaseLayout"
layout: "BaseLayout",
deepLinking: true
})
</script>

View File

@@ -124,7 +124,7 @@ def generate_operation_id(*, route: routing.APIRoute, method: str) -> str:
def generate_operation_summary(*, route: routing.APIRoute, method: str) -> str:
if route.summary:
return route.summary
return route.name.replace("_", " ").title() + " " + method.title()
return route.name.replace("_", " ").title()
def get_openapi_operation_metadata(*, route: routing.APIRoute, method: str) -> Dict:

View File

@@ -68,6 +68,7 @@ nav:
- GraphQL: 'tutorial/graphql.md'
- WebSockets: 'tutorial/websockets.md'
- 'Events: startup - shutdown': 'tutorial/events.md'
- Testing: 'tutorial/testing.md'
- Debugging: 'tutorial/debugging.md'
- Extending OpenAPI: 'tutorial/extending-openapi.md'
- Concurrency and async / await: 'async.md'

View File

@@ -41,7 +41,7 @@ openapi_schema = {
},
},
},
"summary": "Foo Post",
"summary": "Foo",
"operationId": "foo_foo_post",
"requestBody": {
"content": {

View File

@@ -30,7 +30,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Item Get",
"summary": "Read Item",
"operationId": "read_item_items__get",
}
}

View File

@@ -35,7 +35,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
},
},
"summary": "A Get",
"summary": "A",
"operationId": "a_a_get",
}
},
@@ -48,7 +48,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
},
},
"summary": "B Get",
"summary": "B",
"operationId": "b_b_get",
}
},
@@ -61,7 +61,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
},
},
"summary": "C Get",
"summary": "C",
"operationId": "c_c_get",
}
},

View File

@@ -17,7 +17,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Non Operation Get",
"summary": "Non Operation",
"operationId": "non_operation_api_route_get",
}
},
@@ -29,7 +29,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Non Decorated Route Get",
"summary": "Non Decorated Route",
"operationId": "non_decorated_route_non_decorated_route_get",
}
},
@@ -41,7 +41,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Get Text Get",
"summary": "Get Text",
"operationId": "get_text_text_get",
}
},
@@ -63,7 +63,7 @@ openapi_schema = {
},
},
},
"summary": "Get Id Get",
"summary": "Get Id",
"operationId": "get_id_path__item_id__get",
"parameters": [
{
@@ -93,7 +93,7 @@ openapi_schema = {
},
},
},
"summary": "Get Str Id Get",
"summary": "Get Str Id",
"operationId": "get_str_id_path_str__item_id__get",
"parameters": [
{
@@ -123,7 +123,7 @@ openapi_schema = {
},
},
},
"summary": "Get Int Id Get",
"summary": "Get Int Id",
"operationId": "get_int_id_path_int__item_id__get",
"parameters": [
{
@@ -153,7 +153,7 @@ openapi_schema = {
},
},
},
"summary": "Get Float Id Get",
"summary": "Get Float Id",
"operationId": "get_float_id_path_float__item_id__get",
"parameters": [
{
@@ -183,7 +183,7 @@ openapi_schema = {
},
},
},
"summary": "Get Bool Id Get",
"summary": "Get Bool Id",
"operationId": "get_bool_id_path_bool__item_id__get",
"parameters": [
{
@@ -213,7 +213,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Id Get",
"summary": "Get Path Param Id",
"operationId": "get_path_param_id_path_param__item_id__get",
"parameters": [
{
@@ -243,7 +243,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Required Id Get",
"summary": "Get Path Param Required Id",
"operationId": "get_path_param_required_id_path_param-required__item_id__get",
"parameters": [
{
@@ -273,7 +273,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Min Length Get",
"summary": "Get Path Param Min Length",
"operationId": "get_path_param_min_length_path_param-minlength__item_id__get",
"parameters": [
{
@@ -307,7 +307,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Max Length Get",
"summary": "Get Path Param Max Length",
"operationId": "get_path_param_max_length_path_param-maxlength__item_id__get",
"parameters": [
{
@@ -341,7 +341,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Min Max Length Get",
"summary": "Get Path Param Min Max Length",
"operationId": "get_path_param_min_max_length_path_param-min_maxlength__item_id__get",
"parameters": [
{
@@ -376,7 +376,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Gt Get",
"summary": "Get Path Param Gt",
"operationId": "get_path_param_gt_path_param-gt__item_id__get",
"parameters": [
{
@@ -410,7 +410,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Gt0 Get",
"summary": "Get Path Param Gt0",
"operationId": "get_path_param_gt0_path_param-gt0__item_id__get",
"parameters": [
{
@@ -444,7 +444,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Ge Get",
"summary": "Get Path Param Ge",
"operationId": "get_path_param_ge_path_param-ge__item_id__get",
"parameters": [
{
@@ -478,7 +478,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Lt Get",
"summary": "Get Path Param Lt",
"operationId": "get_path_param_lt_path_param-lt__item_id__get",
"parameters": [
{
@@ -512,7 +512,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Lt0 Get",
"summary": "Get Path Param Lt0",
"operationId": "get_path_param_lt0_path_param-lt0__item_id__get",
"parameters": [
{
@@ -546,7 +546,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Le Get",
"summary": "Get Path Param Le",
"operationId": "get_path_param_le_path_param-le__item_id__get",
"parameters": [
{
@@ -580,7 +580,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Lt Gt Get",
"summary": "Get Path Param Lt Gt",
"operationId": "get_path_param_lt_gt_path_param-lt-gt__item_id__get",
"parameters": [
{
@@ -615,7 +615,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Le Ge Get",
"summary": "Get Path Param Le Ge",
"operationId": "get_path_param_le_ge_path_param-le-ge__item_id__get",
"parameters": [
{
@@ -650,7 +650,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Lt Int Get",
"summary": "Get Path Param Lt Int",
"operationId": "get_path_param_lt_int_path_param-lt-int__item_id__get",
"parameters": [
{
@@ -684,7 +684,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Gt Int Get",
"summary": "Get Path Param Gt Int",
"operationId": "get_path_param_gt_int_path_param-gt-int__item_id__get",
"parameters": [
{
@@ -718,7 +718,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Le Int Get",
"summary": "Get Path Param Le Int",
"operationId": "get_path_param_le_int_path_param-le-int__item_id__get",
"parameters": [
{
@@ -752,7 +752,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Ge Int Get",
"summary": "Get Path Param Ge Int",
"operationId": "get_path_param_ge_int_path_param-ge-int__item_id__get",
"parameters": [
{
@@ -786,7 +786,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Lt Gt Int Get",
"summary": "Get Path Param Lt Gt Int",
"operationId": "get_path_param_lt_gt_int_path_param-lt-gt-int__item_id__get",
"parameters": [
{
@@ -821,7 +821,7 @@ openapi_schema = {
},
},
},
"summary": "Get Path Param Le Ge Int Get",
"summary": "Get Path Param Le Ge Int",
"operationId": "get_path_param_le_ge_int_path_param-le-ge-int__item_id__get",
"parameters": [
{
@@ -856,7 +856,7 @@ openapi_schema = {
},
},
},
"summary": "Get Query Get",
"summary": "Get Query",
"operationId": "get_query_query_get",
"parameters": [
{
@@ -886,7 +886,7 @@ openapi_schema = {
},
},
},
"summary": "Get Query Optional Get",
"summary": "Get Query Optional",
"operationId": "get_query_optional_query_optional_get",
"parameters": [
{
@@ -916,7 +916,7 @@ openapi_schema = {
},
},
},
"summary": "Get Query Type Get",
"summary": "Get Query Type",
"operationId": "get_query_type_query_int_get",
"parameters": [
{
@@ -946,7 +946,7 @@ openapi_schema = {
},
},
},
"summary": "Get Query Type Optional Get",
"summary": "Get Query Type Optional",
"operationId": "get_query_type_optional_query_int_optional_get",
"parameters": [
{
@@ -976,7 +976,7 @@ openapi_schema = {
},
},
},
"summary": "Get Query Type Optional Get",
"summary": "Get Query Type Optional",
"operationId": "get_query_type_optional_query_int_default_get",
"parameters": [
{
@@ -1006,7 +1006,7 @@ openapi_schema = {
},
},
},
"summary": "Get Query Param Get",
"summary": "Get Query Param",
"operationId": "get_query_param_query_param_get",
"parameters": [
{
@@ -1036,7 +1036,7 @@ openapi_schema = {
},
},
},
"summary": "Get Query Param Required Get",
"summary": "Get Query Param Required",
"operationId": "get_query_param_required_query_param-required_get",
"parameters": [
{
@@ -1066,7 +1066,7 @@ openapi_schema = {
},
},
},
"summary": "Get Query Param Required Type Get",
"summary": "Get Query Param Required Type",
"operationId": "get_query_param_required_type_query_param-required_int_get",
"parameters": [
{

View File

@@ -72,7 +72,7 @@ openapi_schema = {
},
},
},
"summary": "Get Items Get",
"summary": "Get Items",
"operationId": "get_items_items__item_id__get",
"parameters": [
{
@@ -100,7 +100,7 @@ openapi_schema = {
},
},
},
"summary": "Delete Item Delete",
"summary": "Delete Item",
"operationId": "delete_item_items__item_id__delete",
"parameters": [
{
@@ -136,7 +136,7 @@ openapi_schema = {
},
},
},
"summary": "Options Item Options",
"summary": "Options Item",
"operationId": "options_item_items__item_id__options",
"parameters": [
{
@@ -164,7 +164,7 @@ openapi_schema = {
},
},
},
"summary": "Head Item Head",
"summary": "Head Item",
"operationId": "head_item_items__item_id__head",
"parameters": [
{
@@ -192,7 +192,7 @@ openapi_schema = {
},
},
},
"summary": "Patch Item Patch",
"summary": "Patch Item",
"operationId": "patch_item_items__item_id__patch",
"parameters": [
{
@@ -228,7 +228,7 @@ openapi_schema = {
},
},
},
"summary": "Trace Item Trace",
"summary": "Trace Item",
"operationId": "trace_item_items__item_id__trace",
"parameters": [
{
@@ -258,7 +258,7 @@ openapi_schema = {
},
},
},
"summary": "Get Not Decorated Get",
"summary": "Get Not Decorated",
"operationId": "get_not_decorated_items-not-decorated__item_id__get",
"parameters": [
{

View File

@@ -42,7 +42,7 @@ openapi_schema = {
},
},
},
"summary": "Save Item No Body Post",
"summary": "Save Item No Body",
"operationId": "save_item_no_body_items__post",
"requestBody": {
"content": {

View File

@@ -36,7 +36,7 @@ openapi_schema = {
},
},
},
"summary": "Read Items Get",
"summary": "Read Items",
"operationId": "read_items_items__get",
"parameters": [
{

View File

@@ -34,7 +34,7 @@ openapi_schema = {
},
},
},
"summary": "Save Item No Body Put",
"summary": "Save Item No Body",
"operationId": "save_item_no_body_items__item_id__put",
"parameters": [
{

View File

@@ -36,7 +36,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Current User Get",
"summary": "Read Current User",
"operationId": "read_current_user_users_me_get",
"security": [{"APIKeyCookie": []}],
}

View File

@@ -43,7 +43,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Current User Get",
"summary": "Read Current User",
"operationId": "read_current_user_users_me_get",
"security": [{"APIKeyCookie": []}],
}

View File

@@ -36,7 +36,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Current User Get",
"summary": "Read Current User",
"operationId": "read_current_user_users_me_get",
"security": [{"APIKeyHeader": []}],
}

View File

@@ -42,7 +42,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Current User Get",
"summary": "Read Current User",
"operationId": "read_current_user_users_me_get",
"security": [{"APIKeyHeader": []}],
}

View File

@@ -36,7 +36,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Current User Get",
"summary": "Read Current User",
"operationId": "read_current_user_users_me_get",
"security": [{"APIKeyQuery": []}],
}

View File

@@ -42,7 +42,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Current User Get",
"summary": "Read Current User",
"operationId": "read_current_user_users_me_get",
"security": [{"APIKeyQuery": []}],
}

View File

@@ -26,7 +26,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Current User Get",
"summary": "Read Current User",
"operationId": "read_current_user_users_me_get",
"security": [{"HTTPBase": []}],
}

View File

@@ -32,7 +32,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Current User Get",
"summary": "Read Current User",
"operationId": "read_current_user_users_me_get",
"security": [{"HTTPBase": []}],
}

View File

@@ -29,7 +29,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Current User Get",
"summary": "Read Current User",
"operationId": "read_current_user_users_me_get",
"security": [{"HTTPBasic": []}],
}

View File

@@ -32,7 +32,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Current User Get",
"summary": "Read Current User",
"operationId": "read_current_user_users_me_get",
"security": [{"HTTPBasic": []}],
}

View File

@@ -26,7 +26,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Current User Get",
"summary": "Read Current User",
"operationId": "read_current_user_users_me_get",
"security": [{"HTTPBearer": []}],
}

View File

@@ -32,7 +32,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Current User Get",
"summary": "Read Current User",
"operationId": "read_current_user_users_me_get",
"security": [{"HTTPBearer": []}],
}

View File

@@ -26,7 +26,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Current User Get",
"summary": "Read Current User",
"operationId": "read_current_user_users_me_get",
"security": [{"HTTPDigest": []}],
}

View File

@@ -32,7 +32,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Current User Get",
"summary": "Read Current User",
"operationId": "read_current_user_users_me_get",
"security": [{"HTTPDigest": []}],
}

View File

@@ -60,7 +60,7 @@ openapi_schema = {
},
},
},
"summary": "Read Current User Post",
"summary": "Read Current User",
"operationId": "read_current_user_login_post",
"requestBody": {
"content": {
@@ -82,7 +82,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Current User Get",
"summary": "Read Current User",
"operationId": "read_current_user_users_me_get",
"security": [{"OAuth2": []}],
}

View File

@@ -67,7 +67,7 @@ openapi_schema = {
},
},
},
"summary": "Read Current User Post",
"summary": "Read Current User",
"operationId": "read_current_user_login_post",
"requestBody": {
"content": {
@@ -89,7 +89,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Current User Get",
"summary": "Read Current User",
"operationId": "read_current_user_users_me_get",
"security": [{"OAuth2": []}],
}

View File

@@ -30,7 +30,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Items Get",
"summary": "Read Items",
"operationId": "read_items_items__get",
"security": [{"OAuth2PasswordBearer": []}],
}

View File

@@ -36,7 +36,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Current User Get",
"summary": "Read Current User",
"operationId": "read_current_user_users_me_get",
"security": [{"OpenIdConnect": []}],
}

View File

@@ -42,7 +42,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Current User Get",
"summary": "Read Current User",
"operationId": "read_current_user_users_me_get",
"security": [{"OpenIdConnect": []}],
}

View File

@@ -49,7 +49,7 @@ openapi_schema = {
},
},
},
"summary": "Create Item Get",
"summary": "Create Item",
"operationId": "create_item_items__item_id__get",
"parameters": [
{
@@ -79,7 +79,7 @@ openapi_schema = {
},
},
},
"summary": "Create Item Get",
"summary": "Create Item",
"operationId": "create_item_starlette-items__item_id__get",
"parameters": [
{

View File

@@ -38,7 +38,7 @@ openapi_schema = {
},
},
},
"summary": "Read Item Get",
"summary": "Read Item",
"operationId": "read_item_items__item_id__get",
"parameters": [
{

View File

@@ -34,7 +34,7 @@ openapi_schema = {
},
},
},
"summary": "Read Item Get",
"summary": "Read Item",
"operationId": "read_item_items__item_id__get",
"parameters": [
{

View File

@@ -39,7 +39,7 @@ openapi_schema = {
},
},
},
"summary": "Read Item Get",
"summary": "Read Item",
"operationId": "read_item_items__item_id__get",
"parameters": [
{

View File

@@ -37,7 +37,7 @@ openapi_schema = {
},
},
},
"summary": "Read Item Get",
"summary": "Read Item",
"operationId": "read_item_items__item_id__get",
"parameters": [
{

View File

@@ -20,7 +20,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Items Get",
"summary": "Read Items",
"operationId": "read_items_items__get",
}
}

View File

@@ -22,7 +22,7 @@ openapi_schema = {
},
}
},
"summary": "Read Notes Get",
"summary": "Read Notes",
"operationId": "read_notes_notes__get",
},
"post": {
@@ -46,7 +46,7 @@ openapi_schema = {
},
},
},
"summary": "Create Note Post",
"summary": "Create Note",
"operationId": "create_note_notes__post",
"requestBody": {
"content": {

View File

@@ -18,7 +18,7 @@ openapi_schema = {
}
},
"tags": ["users"],
"summary": "Read Users Get",
"summary": "Read Users",
"operationId": "read_users_users__get",
}
},
@@ -31,7 +31,7 @@ openapi_schema = {
}
},
"tags": ["users"],
"summary": "Read User Me Get",
"summary": "Read User Me",
"operationId": "read_user_me_users_me_get",
}
},
@@ -54,7 +54,7 @@ openapi_schema = {
},
},
"tags": ["users"],
"summary": "Read User Get",
"summary": "Read User",
"operationId": "read_user_users__username__get",
"parameters": [
{
@@ -76,7 +76,7 @@ openapi_schema = {
},
},
"tags": ["items"],
"summary": "Read Items Get",
"summary": "Read Items",
"operationId": "read_items_items__get",
}
},
@@ -100,7 +100,7 @@ openapi_schema = {
},
},
"tags": ["items"],
"summary": "Read Item Get",
"summary": "Read Item",
"operationId": "read_item_items__item_id__get",
"parameters": [
{
@@ -131,7 +131,7 @@ openapi_schema = {
},
},
"tags": ["custom", "items"],
"summary": "Update Item Put",
"summary": "Update Item",
"operationId": "update_item_items__item_id__put",
"parameters": [
{

View File

@@ -27,7 +27,7 @@ openapi_schema = {
},
},
},
"summary": "Create Item Post",
"summary": "Create Item",
"operationId": "create_item_items__post",
"requestBody": {
"content": {

View File

@@ -27,7 +27,7 @@ openapi_schema = {
},
},
},
"summary": "Update Item Put",
"summary": "Update Item",
"operationId": "update_item_items__item_id__put",
"parameters": [
{

View File

@@ -28,7 +28,7 @@ openapi_schema = {
},
},
},
"summary": "Update Item Put",
"summary": "Update Item",
"operationId": "update_item_items__item_id__put",
"parameters": [
{

View File

@@ -27,7 +27,7 @@ openapi_schema = {
},
},
},
"summary": "Read Items Get",
"summary": "Read Items",
"operationId": "read_items_items__get",
"parameters": [
{

View File

@@ -16,7 +16,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Items Get",
"summary": "Read Items",
"operationId": "read_items_items__get",
}
}

View File

@@ -16,7 +16,7 @@ openapi_schema = {
"content": {"text/html": {"schema": {"type": "string"}}},
}
},
"summary": "Read Items Get",
"summary": "Read Items",
"operationId": "read_items_items__get",
}
}

View File

@@ -27,7 +27,7 @@ openapi_schema = {
},
},
},
"summary": "Read Items Get",
"summary": "Read Items",
"operationId": "read_items_items__get",
"parameters": [
{
@@ -69,7 +69,7 @@ openapi_schema = {
},
},
},
"summary": "Read Users Get",
"summary": "Read Users",
"operationId": "read_users_users__get",
"parameters": [
{

View File

@@ -27,7 +27,7 @@ openapi_schema = {
},
},
},
"summary": "Read Items Get",
"summary": "Read Items",
"operationId": "read_items_items__get",
"parameters": [
{

View File

@@ -24,8 +24,8 @@ openapi_schema = {
},
},
},
"summary": "Read Item Get",
"operationId": "read_item_items__item_id__get",
"summary": "Read Items",
"operationId": "read_items_items__item_id__get",
"parameters": [
{
"required": True,

View File

@@ -14,7 +14,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Items Get",
"summary": "Read Items",
"operationId": "read_items_items__get",
}
}

View File

@@ -21,7 +21,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Items Get",
"summary": "Read Items",
"operationId": "read_items_items__get",
}
}

View File

@@ -27,7 +27,7 @@ openapi_schema = {
},
},
},
"summary": "Read Items Put",
"summary": "Read Items",
"operationId": "read_items_items__item_id__put",
"parameters": [
{

View File

@@ -36,7 +36,7 @@ openapi_schema = {
},
},
},
"summary": "Read Item Get",
"summary": "Read Item",
"operationId": "read_item_items__item_id__get",
"parameters": [
{

View File

@@ -24,7 +24,7 @@ openapi_schema = {
},
}
},
"summary": "Read Items Get",
"summary": "Read Items",
"operationId": "read_items_items__get",
}
}

View File

@@ -17,7 +17,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Root Get",
"summary": "Root",
"operationId": "root__get",
}
}

View File

@@ -26,8 +26,8 @@ openapi_schema = {
},
},
},
"summary": "Create Item Get",
"operationId": "create_item_items__item_id__get",
"summary": "Read Item",
"operationId": "read_item_items__item_id__get",
"parameters": [
{
"required": True,

View File

@@ -26,8 +26,8 @@ openapi_schema = {
},
},
},
"summary": "Create Item Header Get",
"operationId": "create_item_header_items-header__item_id__get",
"summary": "Read Item Header",
"operationId": "read_item_header_items-header__item_id__get",
"parameters": [
{
"required": True,

View File

@@ -28,7 +28,7 @@ openapi_schema = {
},
},
},
"summary": "Read Items Get",
"summary": "Read Items",
"operationId": "read_items_items__get",
"parameters": [
{

View File

@@ -16,7 +16,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Items Get",
"summary": "Read Items",
"operationId": "some_specific_id_you_define",
}
}

View File

@@ -18,7 +18,7 @@ openapi_schema = {
}
},
"tags": ["items"],
"summary": "Read Items Get",
"summary": "Read Items",
"operationId": "read_items_items__get",
}
},
@@ -31,7 +31,7 @@ openapi_schema = {
}
},
"tags": ["users"],
"summary": "Read Users Get",
"summary": "Read Users",
"operationId": "read_users_users__get",
}
},
@@ -44,7 +44,7 @@ openapi_schema = {
}
},
"tags": ["items"],
"summary": "Read Elements Get",
"summary": "Read Elements",
"operationId": "read_elements_elements__get",
"deprecated": True,
}

View File

@@ -27,7 +27,7 @@ openapi_schema = {
},
},
},
"summary": "Read User Item Get",
"summary": "Read User Item",
"operationId": "read_user_item_items__item_id__get",
"parameters": [
{

View File

@@ -27,7 +27,7 @@ openapi_schema = {
},
},
},
"summary": "Read User Item Get",
"summary": "Read User Item",
"operationId": "read_user_item_items__item_id__get",
"parameters": [
{

View File

@@ -27,7 +27,7 @@ openapi_schema = {
},
},
},
"summary": "Read Items Get",
"summary": "Read Items",
"operationId": "read_items_items__get",
"parameters": [
{

View File

@@ -26,7 +26,7 @@ openapi_schema = {
},
},
},
"summary": "Read Items Get",
"summary": "Read Items",
"operationId": "read_items_items__get",
"parameters": [
{

View File

@@ -28,7 +28,7 @@ openapi_schema = {
},
},
},
"summary": "Create File Post",
"summary": "Create File",
"operationId": "create_file_files__post",
"requestBody": {
"content": {
@@ -58,7 +58,7 @@ openapi_schema = {
},
},
},
"summary": "Create Upload File Post",
"summary": "Create Upload File",
"operationId": "create_upload_file_uploadfile__post",
"requestBody": {
"content": {

View File

@@ -27,7 +27,7 @@ openapi_schema = {
},
},
},
"summary": "Login Post",
"summary": "Login",
"operationId": "login_login__post",
"requestBody": {
"content": {

View File

@@ -29,7 +29,7 @@ openapi_schema = {
},
},
},
"summary": "Create File Post",
"summary": "Create File",
"operationId": "create_file_files__post",
"requestBody": {
"content": {

View File

@@ -30,7 +30,7 @@ openapi_schema = {
},
},
},
"summary": "Create User Post",
"summary": "Create User",
"operationId": "create_user_user__post",
"requestBody": {
"content": {

View File

@@ -16,7 +16,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Items Get",
"summary": "Read Items",
"operationId": "read_items_items__get",
"security": [{"OAuth2PasswordBearer": []}],
}

View File

@@ -26,7 +26,7 @@ openapi_schema = {
},
},
},
"summary": "Login Post",
"summary": "Login",
"operationId": "login_token_post",
"requestBody": {
"content": {
@@ -46,7 +46,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Users Me Get",
"summary": "Read Users Me",
"operationId": "read_users_me_users_me_get",
"security": [{"OAuth2PasswordBearer": []}],
}

View File

@@ -36,13 +36,13 @@ openapi_schema = {
},
},
},
"summary": "Route Login Access Token Post",
"operationId": "route_login_access_token_token_post",
"summary": "Login For Access Token",
"operationId": "login_for_access_token_token_post",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Body_route_login_access_token"
"$ref": "#/components/schemas/Body_login_for_access_token"
}
}
},
@@ -62,7 +62,7 @@ openapi_schema = {
},
}
},
"summary": "Read Users Me Get",
"summary": "Read Users Me",
"operationId": "read_users_me_users_me__get",
"security": [{"OAuth2PasswordBearer": ["me"]}],
}
@@ -75,7 +75,7 @@ openapi_schema = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Own Items Get",
"summary": "Read Own Items",
"operationId": "read_own_items_users_me_items__get",
"security": [{"OAuth2PasswordBearer": ["items", "me"]}],
}
@@ -83,8 +83,8 @@ openapi_schema = {
},
"components": {
"schemas": {
"Body_route_login_access_token": {
"title": "Body_route_login_access_token",
"Body_login_for_access_token": {
"title": "Body_login_for_access_token",
"required": ["username", "password"],
"type": "object",
"properties": {

View File

@@ -26,7 +26,7 @@ openapi_schema = {
},
},
},
"summary": "Read User Get",
"summary": "Read User",
"operationId": "read_user_users__user_id__get",
"parameters": [
{

View File

@@ -16,7 +16,7 @@ openapi_schema_main = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Main Get",
"summary": "Read Main",
"operationId": "read_main_app_get",
}
}
@@ -34,7 +34,7 @@ openapi_schema_sub = {
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Sub Get",
"summary": "Read Sub",
"operationId": "read_sub_sub_get",
}
}

View File

View File

@@ -0,0 +1,30 @@
from app_testing.test_main import client, test_read_main
openapi_schema = {
"openapi": "3.0.2",
"info": {"title": "Fast API", "version": "0.1.0"},
"paths": {
"/": {
"get": {
"responses": {
"200": {
"description": "Successful Response",
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Main",
"operationId": "read_main__get",
}
}
},
}
def test_openapi_schema():
response = client.get("/openapi.json")
assert response.status_code == 200
assert response.json() == openapi_schema
def test_main():
test_read_main()

View File

@@ -0,0 +1,30 @@
from app_testing.tutorial001 import client, test_read_main
openapi_schema = {
"openapi": "3.0.2",
"info": {"title": "Fast API", "version": "0.1.0"},
"paths": {
"/": {
"get": {
"responses": {
"200": {
"description": "Successful Response",
"content": {"application/json": {"schema": {}}},
}
},
"summary": "Read Main",
"operationId": "read_main__get",
}
}
},
}
def test_openapi_schema():
response = client.get("/openapi.json")
assert response.status_code == 200
assert response.json() == openapi_schema
def test_main():
test_read_main()

View File

@@ -0,0 +1,9 @@
from app_testing.tutorial002 import test_read_main, test_websocket
def test_main():
test_read_main()
def test_ws():
test_websocket()

View File

@@ -0,0 +1,5 @@
from app_testing.tutorial003 import test_read_items
def test_main():
test_read_items()