Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 6 of 6 for users (0.13 sec)

  1. docs/em/docs/tutorial/metadata.md

    * `description`: `str` ⏮️ 📏 📛 🔖. ⚫️ 💪 ✔️ ✍ & 🔜 🎦 🩺 🎚.
    * `externalDocs`: `dict` 🔬 🔢 🧾 ⏮️:
        * `description`: `str` ⏮️ 📏 📛 🔢 🩺.
        * `url` (**✔**): `str` ⏮️ 📛 🔢 🧾.
    
    ### ✍ 🗃 🔖
    
    ➡️ 🔄 👈 🖼 ⏮️ 🔖 `users` & `items`.
    
    ✍ 🗃 👆 🔖 & 🚶‍♀️ ⚫️ `openapi_tags` 🔢:
    
    ```Python hl_lines="3-16  18"
    {!../../../docs_src/metadata/tutorial004.py!}
    ```
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 4.2K bytes
    - Viewed (0)
  2. docs/ru/docs/tutorial/metadata.md

        * `url` (**обязательно**): `str`-значение с URL-адресом для внешней документации.
    
    ### Создание метаданных для тегов
    
    Давайте попробуем сделать это на примере с тегами для `users` и `items`.
    
    Создайте метаданные для ваших тегов и передайте их в параметре `openapi_tags`:
    
    ```Python hl_lines="3-16  18"
    {!../../../docs_src/metadata/tutorial004.py!}
    ```
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 8.3K bytes
    - Viewed (0)
  3. docs/en/docs/tutorial/metadata.md

    {!../../../docs_src/metadata/tutorial002.py!}
    ```
    
    If you want to disable the OpenAPI schema completely you can set `openapi_url=None`, that will also disable the documentation user interfaces that use it.
    
    ## Docs URLs
    
    You can configure the two documentation user interfaces included:
    
    * **Swagger UI**: served at `/docs`.
        * You can set its URL with the parameter `docs_url`.
        * You can disable it by setting `docs_url=None`.
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Sun Mar 31 23:52:53 GMT 2024
    - 5.8K bytes
    - Viewed (0)
  4. docs/de/docs/tutorial/metadata.md

         * `url` (**erforderlich**): ein `str` mit der URL für die externe Dokumentation.
    
    ### Metadaten für Tags erstellen
    
    Versuchen wir das an einem Beispiel mit Tags für `users` und `items`.
    
    Erstellen Sie Metadaten für Ihre Tags und übergeben Sie sie an den Parameter `openapi_tags`:
    
    ```Python hl_lines="3-16  18"
    {!../../../docs_src/metadata/tutorial004.py!}
    ```
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Sat Mar 30 20:25:38 GMT 2024
    - 6.6K bytes
    - Viewed (0)
  5. docs/zh/docs/tutorial/metadata.md

    py!}
    L23:```
    L24:
    L25:!!! tip
    L26:    您可以在 `description` 字段中编写 Markdown,它将在输出中呈现。
    L27:
    L28:通过这样设置,自动 API 文档看起来会像:
    L29:
    L30:<img src="/img/tutorial/metadata/image01.png">
    L31:
    L32:## 标签元数据
    L33:
    L34:### 创建标签元数据
    L35:
    L36:让我们在带有标签的示例中为 `users` 和 `items` 试一下。
    L37:
    L38:创建标签元数据并把它传递给 `openapi_tags` 参数:
    L39:
    L40:```Python hl_lines="3-16  18"
    L41:{!../../../docs_src/metadata/tutorial004.py!}
    L42:```
    L43:
    L44:注意你可以在描述内使用 Markdown,例如「login」会显示为粗体(**login**)以及「fancy」会显示为斜体(_fancy_)。
    L45:
    ...
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 4.7K bytes
    - Viewed (0)
  6. docs/ja/docs/tutorial/metadata.md

    ### ドキュメントの確認
    
    ここで、ドキュメントを確認すると、追加したメタデータがすべて表示されます:
    
    <img src="/img/tutorial/metadata/image02.png">
    
    ### タグの順番
    
    タグのメタデータ辞書の順序は、ドキュメントUIに表示される順序の定義にもなります。
    
    たとえば、`users` はアルファベット順では `items` の後に続きます。しかし、リストの最初に `users` のメタデータ辞書を追加したため、ドキュメントUIでは `users` が先に表示されます。
    
    ## OpenAPI URL
    
    デフォルトでは、OpenAPIスキーマは `/openapi.json` で提供されます。
    
    ただし、パラメータ `openapi_url` を使用して設定を変更できます。
    
    たとえば、`/api/v1/openapi.json` で提供されるように設定するには:
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Sun Mar 31 23:52:53 GMT 2024
    - 4.6K bytes
    - Viewed (0)
Back to top