- Sort Score
- Num 10 results
- Language All
Results 1 - 9 of 9 for openapi_examples (0.1 seconds)
-
fastapi/params.py
category=FastAPIDeprecationWarning, stacklevel=4, ) self.example = example self.include_in_schema = include_in_schema self.openapi_examples = openapi_examples kwargs = dict( default=default, default_factory=default_factory, alias=alias, title=title, description=description, gt=gt,Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Sun Mar 15 11:44:39 GMT 2026 - 25.7K bytes - Click Count (0) -
tests/test_openapi_examples.py
class Item(BaseModel): data: str @app.post("/examples/") def examples( item: Item = Body( examples=[ {"data": "Data in Body examples, example1"}, ], openapi_examples={ "Example One": { "summary": "Example One Summary", "description": "Example One Description", "value": {"data": "Data in Body examples, example1"},
Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Tue Feb 17 09:59:14 GMT 2026 - 16.4K bytes - Click Count (0) -
docs/ja/docs/tutorial/schema-extra-example.md
このOpenAPI固有フィールド`examples`の形は**複数の例**(`list`ではなく)を持つ`dict`であり、それぞれに追加情報が含まれ、その追加情報は**OpenAPI**にも追加されます。 これはOpenAPIに含まれる各JSON Schemaの中には入らず、外側の、*path operation*に直接入ります。 ### `openapi_examples`パラメータの使用 { #using-the-openapi-examples-parameter } FastAPIでは、以下に対してパラメータ`openapi_examples`を使って、OpenAPI固有の`examples`を宣言できます: * `Path()` * `Query()` * `Header()` * `Cookie()` * `Body()` * `Form()` * `File()`Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Fri Mar 20 14:07:17 GMT 2026 - 10.5K bytes - Click Count (0) -
fastapi/openapi/utils.py
if field_info.description: parameter["description"] = field_info.description openapi_examples = getattr(field_info, "openapi_examples", None) example = getattr(field_info, "example", None) if openapi_examples: parameter["examples"] = jsonable_encoder(openapi_examples) elif example is not _Unset: parameter["example"] = jsonable_encoder(example)Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Sun Mar 15 11:44:39 GMT 2026 - 25.6K bytes - Click Count (0) -
docs/de/docs/tutorial/schema-extra-example.md
Dies erfolgt nicht innerhalb jedes in OpenAPI enthaltenen JSON-Schemas, sondern außerhalb, in der *Pfadoperation*. ### Verwendung des Parameters `openapi_examples` { #using-the-openapi-examples-parameter } Sie können die OpenAPI-spezifischen `examples` in FastAPI mit dem Parameter `openapi_examples` deklarieren, für: * `Path()` * `Query()` * `Header()` * `Cookie()` * `Body()` * `Form()` * `File()`Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Thu Mar 19 17:58:09 GMT 2026 - 10.4K bytes - Click Count (0) -
docs/ko/docs/tutorial/schema-extra-example.md
이는 OpenAPI에 포함된 각 JSON 스키마 안으로 포함되지 않으며, *경로 처리*에 직접적으로 포함됩니다. ### `openapi_examples` 매개변수 사용하기 { #using-the-openapi-examples-parameter } 다음에 대해 FastAPI에서 매개변수 `openapi_examples`로 OpenAPI-특화 `examples`를 선언할 수 있습니다: * `Path()` * `Query()` * `Header()` * `Cookie()` * `Body()` * `Form()` * `File()`Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Fri Mar 20 14:06:26 GMT 2026 - 10.3K bytes - Click Count (0) -
docs/ru/docs/tutorial/schema-extra-example.md
### Использование параметра `openapi_examples` { #using-the-openapi-examples-parameter } Вы можете объявлять специфические для OpenAPI `examples` в FastAPI с помощью параметра `openapi_examples` для: * `Path()` * `Query()` * `Header()` * `Cookie()` * `Body()` * `Form()` * `File()`Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Thu Mar 19 17:56:20 GMT 2026 - 13.8K bytes - Click Count (0) -
docs/fr/docs/tutorial/schema-extra-example.md
### Utiliser le paramètre `openapi_examples` { #using-the-openapi-examples-parameter } Vous pouvez déclarer le `examples` spécifique à OpenAPI dans FastAPI avec le paramètre `openapi_examples` pour : * `Path()` * `Query()` * `Header()` * `Cookie()` * `Body()` * `Form()` * `File()`Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Thu Mar 19 18:37:13 GMT 2026 - 10.2K bytes - Click Count (0) -
docs/uk/docs/tutorial/schema-extra-example.md
### Використання параметра `openapi_examples` { #using-the-openapi-examples-parameter } Ви можете оголосити специфічні для OpenAPI `examples` у FastAPI за допомогою параметра `openapi_examples` для: * `Path()` * `Query()` * `Header()` * `Cookie()` * `Body()` * `Form()` * `File()`Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Thu Mar 19 18:27:41 GMT 2026 - 13.3K bytes - Click Count (0)