- Sort Score
- Num 10 results
- Language All
Results 1 - 10 of 19 for openapi_schema (0.07 seconds)
-
docs/en/docs/how-to/extending-openapi.md
It just returns a JSON response with the result of the application's `.openapi()` method. By default, what the method `.openapi()` does is check the property `.openapi_schema` to see if it has contents and return them. If it doesn't, it generates them using the utility function at `fastapi.openapi.utils.get_openapi`. And that function `get_openapi()` receives as parameters:
Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Thu Mar 05 18:13:19 GMT 2026 - 3.3K bytes - Click Count (0) -
tests/test_openapi_model_description_trim_on_formfeed.py
pass client = TestClient(app) def test_openapi(): response = client.get("/openapi.json") assert response.status_code == 200, response.text openapi_schema = response.json() assert openapi_schema["components"]["schemas"]["MyModel"]["description"] == ( "A model with a form feed character in the title.\n"
Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Tue Jun 17 07:46:27 GMT 2025 - 660 bytes - Click Count (0) -
docs/zh-hant/docs/how-to/extending-openapi.md
一般(預設)的流程如下。 `FastAPI` 應用程式(實例)有一個 `.openapi()` 方法,會回傳 OpenAPI 結構。 在建立應用物件時,會同時註冊一個 `/openapi.json`(或你在 `openapi_url` 設定的路徑)的路徑操作(path operation)。 這個路徑只會回傳一個 JSON 回應,內容就是應用的 `.openapi()` 方法結果。 預設情況下,`.openapi()` 會先檢查 `.openapi_schema` 屬性是否已有內容,有的話就直接回傳。 若沒有,則會呼叫 `fastapi.openapi.utils.get_openapi` 這個工具函式來產生。 `get_openapi()` 函式會接收以下參數: * `title`:OpenAPI 的標題,會顯示在文件中。 * `version`:你的 API 版本,例如 `2.5.0`。
Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Fri Mar 20 17:05:38 GMT 2026 - 3K bytes - Click Count (0) -
docs/ja/docs/how-to/extending-openapi.md
アプリケーションオブジェクトの作成時に、`/openapi.json`(または `openapi_url` に設定したパス)への path operation が登録されます。 これは単に、アプリケーションの `.openapi()` メソッドの結果を含む JSON レスポンスを返します。 デフォルトでは、`.openapi()` メソッドはプロパティ `.openapi_schema` に内容があるかを確認し、あればそれを返します。 なければ、`fastapi.openapi.utils.get_openapi` にあるユーティリティ関数を使って生成します。 この関数 `get_openapi()` は次の引数を受け取ります: - `title`: ドキュメントに表示される OpenAPI のタイトル。 - `version`: API のバージョン。例: `2.5.0`。
Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Fri Mar 20 14:07:17 GMT 2026 - 3.9K bytes - Click Count (0) -
docs_src/extending_openapi/tutorial001_py310.py
def custom_openapi(): if app.openapi_schema: return app.openapi_schema openapi_schema = get_openapi( title="Custom title", version="2.5.0", summary="This is a very custom OpenAPI schema", description="Here's a longer description of the custom **OpenAPI** schema", routes=app.routes, ) openapi_schema["info"]["x-logo"] = {
Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Thu Feb 12 13:19:43 GMT 2026 - 737 bytes - Click Count (0) -
docs/zh/docs/how-to/extending-openapi.md
常规(默认)流程如下。 `FastAPI` 应用(实例)有一个 `.openapi()` 方法,预期返回 OpenAPI 架构。 在创建应用对象时,会注册一个用于 `/openapi.json`(或你在 `openapi_url` 中设置的路径)的路径操作。 它只会返回一个 JSON 响应,内容是应用 `.openapi()` 方法的结果。 默认情况下,`.openapi()` 方法会检查属性 `.openapi_schema` 是否已有内容,若有则直接返回。 如果没有,则使用 `fastapi.openapi.utils.get_openapi` 工具函数生成。 该 `get_openapi()` 函数接收以下参数: - `title`:OpenAPI 标题,显示在文档中。 - `version`:你的 API 版本,例如 `2.5.0`。
Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Fri Mar 20 17:06:37 GMT 2026 - 3K bytes - Click Count (0) -
docs/ru/docs/how-to/extending-openapi.md
Она просто возвращает JSON-ответ с результатом вызова метода приложения `.openapi()`. По умолчанию метод `.openapi()` проверяет свойство `.openapi_schema`: если в нём уже есть данные, возвращает их. Если нет — генерирует схему с помощью вспомогательной функции `fastapi.openapi.utils.get_openapi`. Функция `get_openapi()` принимает параметры:
Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Thu Mar 19 17:56:20 GMT 2026 - 4.8K bytes - Click Count (0) -
docs/tr/docs/how-to/extending-openapi.md
Bu path operation, uygulamanın `.openapi()` metodunun sonucunu içeren bir JSON response döndürür. Varsayılan olarak `.openapi()` metodunun yaptığı şey, `.openapi_schema` özelliğinde içerik olup olmadığını kontrol etmek ve varsa onu döndürmektir. Eğer yoksa, `fastapi.openapi.utils.get_openapi` konumundaki yardımcı (utility) fonksiyonu kullanarak şemayı üretir.
Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Fri Mar 20 07:53:17 GMT 2026 - 3.5K bytes - Click Count (0) -
docs/fr/docs/how-to/extending-openapi.md
Il renvoie simplement une réponse JSON avec le résultat de la méthode `.openapi()` de l'application. Par défaut, la méthode `.openapi()` vérifie la propriété `.openapi_schema` pour voir si elle contient des données et les renvoie. Sinon, elle les génère à l'aide de la fonction utilitaire `fastapi.openapi.utils.get_openapi`. Et cette fonction `get_openapi()` reçoit comme paramètres :
Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Thu Mar 19 18:37:13 GMT 2026 - 3.7K bytes - Click Count (0) -
docs/uk/docs/how-to/extending-openapi.md
Вона просто повертає відповідь JSON з результатом методу `.openapi()` застосунку. Типово метод `.openapi()` перевіряє властивість `.openapi_schema`, і якщо там вже є дані, повертає їх. Якщо ні, він генерує їх за допомогою утилітарної функції `fastapi.openapi.utils.get_openapi`. Функція `get_openapi()` приймає такі параметри:
Created: Sun Apr 05 07:19:11 GMT 2026 - Last Modified: Thu Mar 19 18:27:41 GMT 2026 - 4.7K bytes - Click Count (0)