Browse Source

Remove code examples for Python 3.8 in `generate_clients`

pull/14510/head
Yurii Motov 7 months ago
parent
commit
e5f3b78407
  1. 2
      docs/en/docs/advanced/generate-clients.md
  2. 28
      docs_src/generate_clients/tutorial001.py
  3. 38
      docs_src/generate_clients/tutorial002.py
  4. 44
      docs_src/generate_clients/tutorial003.py
  5. 0
      docs_src/generate_clients/tutorial004_py39.py
  6. 2
      tests/test_tutorial/test_generate_clients/test_tutorial003.py

2
docs/en/docs/advanced/generate-clients.md

@ -167,7 +167,7 @@ But for the generated client, we could **modify** the OpenAPI operation IDs righ
We could download the OpenAPI JSON to a file `openapi.json` and then we could **remove that prefixed tag** with a script like this:
{* ../../docs_src/generate_clients/tutorial004.py *}
{* ../../docs_src/generate_clients/tutorial004_py39.py *}
//// tab | Node.js

28
docs_src/generate_clients/tutorial001.py

@ -1,28 +0,0 @@
from typing import List
from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
name: str
price: float
class ResponseMessage(BaseModel):
message: str
@app.post("/items/", response_model=ResponseMessage)
async def create_item(item: Item):
return {"message": "item received"}
@app.get("/items/", response_model=List[Item])
async def get_items():
return [
{"name": "Plumbus", "price": 3},
{"name": "Portal Gun", "price": 9001},
]

38
docs_src/generate_clients/tutorial002.py

@ -1,38 +0,0 @@
from typing import List
from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
name: str
price: float
class ResponseMessage(BaseModel):
message: str
class User(BaseModel):
username: str
email: str
@app.post("/items/", response_model=ResponseMessage, tags=["items"])
async def create_item(item: Item):
return {"message": "Item received"}
@app.get("/items/", response_model=List[Item], tags=["items"])
async def get_items():
return [
{"name": "Plumbus", "price": 3},
{"name": "Portal Gun", "price": 9001},
]
@app.post("/users/", response_model=ResponseMessage, tags=["users"])
async def create_user(user: User):
return {"message": "User received"}

44
docs_src/generate_clients/tutorial003.py

@ -1,44 +0,0 @@
from typing import List
from fastapi import FastAPI
from fastapi.routing import APIRoute
from pydantic import BaseModel
def custom_generate_unique_id(route: APIRoute):
return f"{route.tags[0]}-{route.name}"
app = FastAPI(generate_unique_id_function=custom_generate_unique_id)
class Item(BaseModel):
name: str
price: float
class ResponseMessage(BaseModel):
message: str
class User(BaseModel):
username: str
email: str
@app.post("/items/", response_model=ResponseMessage, tags=["items"])
async def create_item(item: Item):
return {"message": "Item received"}
@app.get("/items/", response_model=List[Item], tags=["items"])
async def get_items():
return [
{"name": "Plumbus", "price": 3},
{"name": "Portal Gun", "price": 9001},
]
@app.post("/users/", response_model=ResponseMessage, tags=["users"])
async def create_user(user: User):
return {"message": "User received"}

0
docs_src/generate_clients/tutorial004.py → docs_src/generate_clients/tutorial004_py39.py

2
tests/test_tutorial/test_generate_clients/test_tutorial003.py

@ -1,6 +1,6 @@
from fastapi.testclient import TestClient
from docs_src.generate_clients.tutorial003 import app
from docs_src.generate_clients.tutorial003_py39 import app
client = TestClient(app)

Loading…
Cancel
Save