Search Options

Display Count
Sort
Preferred Language
Advanced Search

Results 1 - 10 of 23 for get_openapi (0.23 seconds)

  1. docs/en/docs/how-to/extending-openapi.md

    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:
    
    * `title`: The OpenAPI title, shown in the docs.
    * `version`: The version of your API, e.g. `2.5.0`.
    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)
  2. docs/zh-hant/docs/how-to/extending-openapi.md

    這個路徑只會回傳一個 JSON 回應,內容就是應用的 `.openapi()` 方法結果。
    
    預設情況下,`.openapi()` 會先檢查 `.openapi_schema` 屬性是否已有內容,有的話就直接回傳。
    
    若沒有,則會呼叫 `fastapi.openapi.utils.get_openapi` 這個工具函式來產生。
    
    `get_openapi()` 函式會接收以下參數:
    
    * `title`:OpenAPI 的標題,會顯示在文件中。
    * `version`:你的 API 版本,例如 `2.5.0`。
    * `openapi_version`:所使用的 OpenAPI 規格版本。預設為最新版本:`3.1.0`。
    * `summary`:API 的簡短摘要。
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Fri Mar 20 17:05:38 GMT 2026
    - 3K bytes
    - Click Count (0)
  3. docs/ja/docs/how-to/extending-openapi.md

    これは単に、アプリケーションの `.openapi()` メソッドの結果を含む JSON レスポンスを返します。
    
    デフォルトでは、`.openapi()` メソッドはプロパティ `.openapi_schema` に内容があるかを確認し、あればそれを返します。
    
    なければ、`fastapi.openapi.utils.get_openapi` にあるユーティリティ関数を使って生成します。
    
    この関数 `get_openapi()` は次の引数を受け取ります:
    
    - `title`: ドキュメントに表示される OpenAPI のタイトル。
    - `version`: API のバージョン。例: `2.5.0`。
    - `openapi_version`: 使用する OpenAPI 仕様のバージョン。デフォルトは最新の `3.1.0`。
    - `summary`: API の短い概要。
    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)
  4. fastapi/openapi/utils.py

        flat_models = callback_flat_models + list(
            body_fields_from_routes + responses_from_routes + request_fields_from_routes
        )
        return flat_models
    
    
    def get_openapi(
        *,
        title: str,
        version: str,
        openapi_version: str = "3.1.0",
        summary: str | None = None,
        description: str | None = None,
        routes: Sequence[BaseRoute],
    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)
  5. docs_src/extending_openapi/tutorial001_py310.py

    from fastapi import FastAPI
    from fastapi.openapi.utils import get_openapi
    
    app = FastAPI()
    
    
    @app.get("/items/")
    async def read_items():
        return [{"name": "Foo"}]
    
    
    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",
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Feb 12 13:19:43 GMT 2026
    - 737 bytes
    - Click Count (0)
  6. docs/zh/docs/how-to/extending-openapi.md

    在创建应用对象时,会注册一个用于 `/openapi.json`(或你在 `openapi_url` 中设置的路径)的路径操作。
    
    它只会返回一个 JSON 响应,内容是应用 `.openapi()` 方法的结果。
    
    默认情况下,`.openapi()` 方法会检查属性 `.openapi_schema` 是否已有内容,若有则直接返回。
    
    如果没有,则使用 `fastapi.openapi.utils.get_openapi` 工具函数生成。
    
    该 `get_openapi()` 函数接收以下参数:
    
    - `title`:OpenAPI 标题,显示在文档中。
    - `version`:你的 API 版本,例如 `2.5.0`。
    - `openapi_version`:使用的 OpenAPI 规范版本。默认是最新的 `3.1.0`。
    - `summary`:API 的简短摘要。
    - `description`:API 的描述,可包含 Markdown,并会展示在文档中。
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Fri Mar 20 17:06:37 GMT 2026
    - 3K bytes
    - Click Count (0)
  7. tests/test_additional_responses_bad.py

            "/a": {
                "get": {
                    "responses": {
                        # this is how one would imagine the openapi schema to be
                        # but since the key is not valid, openapi.utils.get_openapi will raise ValueError
                        "hello": {"description": "Not a valid additional response"},
                        "200": {
                            "description": "Successful Response",
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Fri Jun 30 18:25:16 GMT 2023
    - 1.1K bytes
    - Click Count (0)
  8. docs/ru/docs/how-to/extending-openapi.md

    По умолчанию метод `.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: Thu Mar 19 17:56:20 GMT 2026
    - 4.8K bytes
    - Click Count (0)
  9. docs/tr/docs/how-to/extending-openapi.md

    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.
    
    Ve `get_openapi()` fonksiyonu şu parametreleri alır:
    
    * `title`: Dokümanlarda gösterilen OpenAPI başlığı.
    * `version`: API'nizin sürümü, örn. `2.5.0`.
    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)
  10. docs/uk/docs/how-to/extending-openapi.md

    Типово метод `.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: Thu Mar 19 18:27:41 GMT 2026
    - 4.7K bytes
    - Click Count (0)
Back to Top