mirror
/
tiangolo.fastapi
mirror of https://github.com/tiangolo/fastapi
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

✅ Update query param tests and docs

pull/11/head
Sebastián Ramírez 6 years ago
parent
b59e8ffcf6
commit
4b94da956c
7 changed files with 272 additions and 12 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 19
      docs/tutorial/query-params.md
  2. 6
      docs/tutorial/src/query_params/tutorial005.py
  3. 9
      docs/tutorial/src/query_params/tutorial006.py
  4. 5
      tests/test_tutorial/test_cookie_params/test_tutorial001.py
  5. 0
      tests/test_tutorial/test_query_params/__init__.py
  6. 104
      tests/test_tutorial/test_query_params/test_tutorial005.py
  7. 141
      tests/test_tutorial/test_query_params/test_tutorial006.py

19
docs/tutorial/query-params.md
View File

@ -140,7 +140,7 @@ Here the query parameter `needy` is a required query parameter of type `str`.
If you open in your browser a URL like: If you open in your browser a URL like:
``` ```
http://127.0.0.1:8000/users/2/items/foo-item http://127.0.0.1:8000/items/foo-item
``` ```
...without adding the required parameter `needy`, you will see an error like: ...without adding the required parameter `needy`, you will see an error like:
@ -163,7 +163,7 @@ http://127.0.0.1:8000/users/2/items/foo-item
As `needy` is a required parameter, you would need to set it in the URL: As `needy` is a required parameter, you would need to set it in the URL:
``` ```
http://127.0.0.1:8000/users/2/items/foo-item?needy=sooooneedy http://127.0.0.1:8000/items/foo-item?needy=sooooneedy
``` ```
...this would work: ...this would work:
@ -171,7 +171,18 @@ http://127.0.0.1:8000/users/2/items/foo-item?needy=sooooneedy
```JSON ```JSON
{ {
"item_id": "foo-item", "item_id": "foo-item",
"owner_id": 2,
"needy": "sooooneedy" "needy": "sooooneedy"
} }
``` ```
And of course, you can define some parameters as required, some as having a default value, and some entirely optional:
```Python hl_lines="7"
{!./tutorial/src/query_params/tutorial006.py!}
```
In this case, there are 3 query parameters:
* `needy`, a required `str`.
* `skip`, an `int` with a default value of `0`.
* `limit`, an optional `int`.

6
docs/tutorial/src/query_params/tutorial005.py
View File

@ -3,7 +3,7 @@ from fastapi import FastAPI
app = FastAPI() app = FastAPI()
@app.get("/users/{user_id}/items/{item_id}") @app.get("/items/{item_id}")
async def read_user_item(user_id: int, item_id: str, needy: str): async def read_user_item(item_id: str, needy: str):
item = {"item_id": item_id, "owner_id": user_id, "needy": needy} item = {"item_id": item_id, "needy": needy}
return item return item

9
docs/tutorial/src/query_params/tutorial006.py
View File

@ -0,0 +1,9 @@
from fastapi import FastAPI
app = FastAPI()
@app.get("/items/{item_id}")
async def read_user_item(item_id: str, needy: str, skip: int = 0, limit: int = None):
item = {"item_id": item_id, "needy": needy, "skip": skip, "limit": limit}
return item

5
tests/test_tutorial/test_cookie_params/test_tutorial001.py
View File

@ -1,5 +1,3 @@
import sys
import pytest import pytest
from starlette.testclient import TestClient from starlette.testclient import TestClient
@ -7,9 +5,6 @@ from cookie_params.tutorial001 import app
client = TestClient(app) client = TestClient(app)
print(sys.path)
openapi_schema = { openapi_schema = {
"openapi": "3.0.2", "openapi": "3.0.2",
"info": {"title": "Fast API", "version": "0.1.0"}, "info": {"title": "Fast API", "version": "0.1.0"},

0
tests/test_tutorial/test_query_params/__init__.py
View File

104
tests/test_tutorial/test_query_params/test_tutorial005.py
View File

@ -0,0 +1,104 @@
import pytest
from starlette.testclient import TestClient
from query_params.tutorial005 import app
client = TestClient(app)
openapi_schema = {
"openapi": "3.0.2",
"info": {"title": "Fast API", "version": "0.1.0"},
"paths": {
"/items/{item_id}": {
"get": {
"responses": {
"200": {
"description": "Successful Response",
"content": {"application/json": {"schema": {}}},
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
},
},
"summary": "Read User Item Get",
"operationId": "read_user_item_items__item_id__get",
"parameters": [
{
"required": True,
"schema": {"title": "Item_Id", "type": "string"},
"name": "item_id",
"in": "path",
},
{
"required": True,
"schema": {"title": "Needy", "type": "string"},
"name": "needy",
"in": "query",
},
],
}
}
},
"components": {
"schemas": {
"ValidationError": {
"title": "ValidationError",
"required": ["loc", "msg", "type"],
"type": "object",
"properties": {
"loc": {
"title": "Location",
"type": "array",
"items": {"type": "string"},
},
"msg": {"title": "Message", "type": "string"},
"type": {"title": "Error Type", "type": "string"},
},
},
"HTTPValidationError": {
"title": "HTTPValidationError",
"type": "object",
"properties": {
"detail": {
"title": "Detail",
"type": "array",
"items": {"$ref": "#/components/schemas/ValidationError"},
}
},
},
}
},
}
query_required = {
"detail": [
{
"loc": ["query", "needy"],
"msg": "field required",
"type": "value_error.missing",
}
]
}
@pytest.mark.parametrize(
"path,expected_status,expected_response",
[
("/openapi.json", 200, openapi_schema),
("/items/foo?needy=very", 200, {"item_id": "foo", "needy": "very"}),
("/items/foo", 422, query_required),
("/items/foo", 422, query_required),
],
)
def test(path, expected_status, expected_response):
response = client.get(path)
assert response.status_code == expected_status
assert response.json() == expected_response

141
tests/test_tutorial/test_query_params/test_tutorial006.py
View File

@ -0,0 +1,141 @@
import pytest
from starlette.testclient import TestClient
from query_params.tutorial006 import app
client = TestClient(app)
openapi_schema = {
"openapi": "3.0.2",
"info": {"title": "Fast API", "version": "0.1.0"},
"paths": {
"/items/{item_id}": {
"get": {
"responses": {
"200": {
"description": "Successful Response",
"content": {"application/json": {"schema": {}}},
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
},
},
"summary": "Read User Item Get",
"operationId": "read_user_item_items__item_id__get",
"parameters": [
{
"required": True,
"schema": {"title": "Item_Id", "type": "string"},
"name": "item_id",
"in": "path",
},
{
"required": True,
"schema": {"title": "Needy", "type": "string"},
"name": "needy",
"in": "query",
},
{
"required": False,
"schema": {"title": "Skip", "type": "integer", "default": 0},
"name": "skip",
"in": "query",
},
{
"required": False,
"schema": {"title": "Limit", "type": "integer"},
"name": "limit",
"in": "query",
},
],
}
}
},
"components": {
"schemas": {
"ValidationError": {
"title": "ValidationError",
"required": ["loc", "msg", "type"],
"type": "object",
"properties": {
"loc": {
"title": "Location",
"type": "array",
"items": {"type": "string"},
},
"msg": {"title": "Message", "type": "string"},
"type": {"title": "Error Type", "type": "string"},
},
},
"HTTPValidationError": {
"title": "HTTPValidationError",
"type": "object",
"properties": {
"detail": {
"title": "Detail",
"type": "array",
"items": {"$ref": "#/components/schemas/ValidationError"},
}
},
},
}
},
}
query_required = {
"detail": [
{
"loc": ["query", "needy"],
"msg": "field required",
"type": "value_error.missing",
}
]
}
@pytest.mark.parametrize(
"path,expected_status,expected_response",
[
("/openapi.json", 200, openapi_schema),
(
"/items/foo?needy=very",
200,
{"item_id": "foo", "needy": "very", "skip": 0, "limit": None},
),
(
"/items/foo?skip=a&limit=b",
422,
{
"detail": [
{
"loc": ["query", "needy"],
"msg": "field required",
"type": "value_error.missing",
},
{
"loc": ["query", "skip"],
"msg": "value is not a valid integer",
"type": "type_error.integer",
},
{
"loc": ["query", "limit"],
"msg": "value is not a valid integer",
"type": "type_error.integer",
},
]
},
),
],
)
def test(path, expected_status, expected_response):
response = client.get(path)
assert response.status_code == expected_status
assert response.json() == expected_response
Write Preview
Loading…
Cancel
Save