Search Options

Display Count
Sort
Preferred Language
Advanced Search

Results 1 - 10 of 14 for externalDocs (0.1 seconds)

  1. docs_src/metadata/tutorial004_py310.py

            "description": "Operations with users. The **login** logic is also here.",
        },
        {
            "name": "items",
            "description": "Manage items. So _fancy_ they have their own docs.",
            "externalDocs": {
                "description": "Items external docs",
                "url": "https://fastapi.tiangolo.com/",
            },
        },
    ]
    
    app = FastAPI(openapi_tags=tags_metadata)
    
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Feb 12 13:19:43 GMT 2026
    - 693 bytes
    - Click Count (0)
  2. docs/en/docs/tutorial/metadata.md

    * `description`: a `str` with a short description for the tag. It can have Markdown and will be shown in the docs UI.
    * `externalDocs`: a `dict` describing external documentation with:
        * `description`: a `str` with a short description for the external docs.
        * `url` (**required**): a `str` with the URL for the external documentation.
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Mar 05 18:13:19 GMT 2026
    - 5.8K bytes
    - Click Count (0)
  3. docs/zh/docs/tutorial/metadata.md

    你也可以通过参数 `openapi_tags` 为用于分组路径操作的不同标签添加额外的元数据。
    
    它接收一个列表,列表中每个标签对应一个字典。
    
    每个字典可以包含:
    
    - `name`(必填):一个 `str`,与在你的*路径操作*和 `APIRouter` 的 `tags` 参数中使用的标签名相同。
    - `description`:一个 `str`,该标签的简短描述。可以使用 Markdown,并会显示在文档 UI 中。
    - `externalDocs`:一个 `dict`,描述外部文档,包含:
        - `description`:一个 `str`,该外部文档的简短描述。
        - `url`(必填):一个 `str`,该外部文档的 URL。
    
    ### 创建标签元数据 { #create-metadata-for-tags }
    
    让我们在带有标签的示例中为 `users` 和 `items` 试一下。
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Fri Mar 20 17:06:37 GMT 2026
    - 5.6K bytes
    - Click Count (0)
  4. docs/zh-hant/docs/tutorial/metadata.md

    它接收一個 list,其中每個標籤對應一個 dictionary。
    
    每個 dictionary 可包含:
    
    * `name`(**必填**):一個 `str`,其值需與你在路徑操作與 `APIRouter`s 的 `tags` 參數中使用的標籤名稱相同。
    * `description`:一個 `str`,為該標籤的簡短描述。可使用 Markdown,並會顯示在文件介面中。
    * `externalDocs`:一個 `dict`,描述外部文件,包含:
        * `description`:一個 `str`,外部文件的簡短描述。
        * `url`(**必填**):一個 `str`,外部文件的 URL。
    
    ### 建立標籤的中繼資料 { #create-metadata-for-tags }
    
    我們用 `users` 與 `items` 兩個標籤來示範。
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Fri Mar 20 17:05:38 GMT 2026
    - 5.6K bytes
    - Click Count (0)
  5. docs/ja/docs/tutorial/metadata.md

    それぞれのタグごとに1つの辞書を含むリストを取ります。
    
    それぞれの辞書は以下を含められます:
    
    * `name` (**必須**): *path operation* および `APIRouter` の `tags` パラメータで使用するのと同じタグ名の `str`。
    * `description`: タグの短い説明の `str`。Markdownを含められ、ドキュメントUIに表示されます。
    * `externalDocs`: 外部ドキュメントを説明する `dict`。以下を含みます:
        * `description`: 外部ドキュメントの短い説明の `str`。
        * `url` (**必須**): 外部ドキュメントのURLの `str`。
    
    ### タグのメタデータの作成 { #create-metadata-for-tags }
    
    `users` と `items` のタグを使った例で試してみましょう。
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Fri Mar 20 14:07:17 GMT 2026
    - 6.9K bytes
    - Click Count (0)
  6. docs/ko/docs/tutorial/metadata.md

    리스트는 각 태그에 대해 하나의 딕셔너리를 포함합니다.
    
    각 딕셔너리에는 다음이 포함될 수 있습니다:
    
    * `name` (**필수**): *경로 처리* 및 `APIRouter`의 `tags` 매개변수에서 사용하는 태그 이름과 동일한 `str`입니다.
    * `description`: 태그에 대한 간단한 설명을 담은 `str`입니다. 마크다운을 포함할 수 있으며 문서 UI에 표시됩니다.
    * `externalDocs`: 외부 문서를 설명하는 `dict`이며:
        * `description`: 외부 문서에 대한 간단한 설명을 담은 `str`입니다.
        * `url` (**필수**): 외부 문서의 URL을 담은 `str`입니다.
    
    ### 태그에 대한 메타데이터 생성 { #create-metadata-for-tags }
    
    `users` 및 `items`에 대한 태그 예시로 시도해 보겠습니다.
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Fri Mar 20 14:06:26 GMT 2026
    - 6.6K bytes
    - Click Count (0)
  7. docs/ru/docs/tutorial/metadata.md

    * `description`: `str`-значение с кратким описанием для тега. Может содержать Markdown и будет отображаться в UI документации.
    * `externalDocs`:  `dict`-значение описывающее внешнюю документацию. Включает в себя:
        * `description`: `str`-значение с кратким описанием для внешней документации.
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Mar 19 17:56:20 GMT 2026
    - 9.2K bytes
    - Click Count (0)
  8. docs/tr/docs/tutorial/metadata.md

    * `description`: tag için kısa bir açıklama içeren `str`. Markdown içerebilir ve doküman arayüzünde gösterilir.
    * `externalDocs`: harici dokümanları tanımlayan bir `dict`:
        * `description`: harici dokümanlar için kısa açıklama içeren `str`.
        * `url` (**zorunlu**): harici dokümantasyonun URL'sini içeren `str`.
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Fri Mar 20 07:53:17 GMT 2026
    - 6.2K bytes
    - Click Count (0)
  9. docs/uk/docs/tutorial/metadata.md

    * `description`: `str` з коротким описом тегу. Може містити Markdown і буде показано в інтерфейсі документації.
    * `externalDocs`: `dict`, який описує зовнішню документацію з такими полями:
        * `description`: `str` з коротким описом зовнішньої документації.
        * `url` (**обов'язково**): `str` з URL-адресою зовнішньої документації.
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Mar 19 18:27:41 GMT 2026
    - 8.8K bytes
    - Click Count (0)
  10. docs/de/docs/tutorial/metadata.md

    * `description`: ein `str` mit einer kurzen Beschreibung für das Tag. Sie kann Markdown enthalten und wird in der Benutzeroberfläche der Dokumentation angezeigt.
    * `externalDocs`: ein `dict`, das externe Dokumentation beschreibt mit:
        * `description`: ein `str` mit einer kurzen Beschreibung für die externe Dokumentation.
        * `url` (**erforderlich**): ein `str` mit der URL für die externe Dokumentation.
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Mar 19 17:58:09 GMT 2026
    - 6.8K bytes
    - Click Count (0)
Back to Top