Search Options

Results per page
Sort
Preferred Languages
Advance

Results 21 - 29 of 29 for OPENAPI_URL (0.06 sec)

  1. tests/test_tutorial/test_conditional_openapi/test_tutorial001.py

        importlib.reload(tutorial001)
    
        client = TestClient(tutorial001.app)
        return client
    
    
    @needs_pydanticv2
    def test_disable_openapi(monkeypatch):
        monkeypatch.setenv("OPENAPI_URL", "")
        # Load the client after setting the env var
        client = get_client()
        response = client.get("/openapi.json")
        assert response.status_code == 404, response.text
        response = client.get("/docs")
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Fri Jul 07 17:12:13 UTC 2023
    - 1.8K bytes
    - Viewed (0)
  2. docs/de/docs/tutorial/metadata.md

    Sie können das aber mit dem Parameter `openapi_url` konfigurieren.
    
    Um beispielsweise festzulegen, dass es unter `/api/v1/openapi.json` bereitgestellt wird:
    
    ```Python hl_lines="3"
    {!../../docs_src/metadata/tutorial002.py!}
    ```
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 06 20:36:54 UTC 2024
    - 6.6K bytes
    - Viewed (0)
  3. docs/zh/docs/tutorial/metadata.md

    例如按照字母顺序,即使 `users` 排在 `items` 之后,它也会显示在前面,因为我们将它的元数据添加为列表内的第一个字典。
    
    ## OpenAPI URL
    
    默认情况下,OpenAPI 模式服务于 `/openapi.json`。
    
    但是你可以通过参数 `openapi_url` 对其进行配置。
    
    例如,将其设置为服务于 `/api/v1/openapi.json`:
    
    ```Python hl_lines="3"
    {!../../docs_src/metadata/tutorial002.py!}
    ```
    
    如果你想完全禁用 OpenAPI 模式,可以将其设置为 `openapi_url=None`,这样也会禁用使用它的文档用户界面。
    
    ## 文档 URLs
    
    你可以配置两个文档用户界面,包括:
    
    * **Swagger UI**:服务于 `/docs`。
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 06 20:36:54 UTC 2024
    - 4.6K bytes
    - Viewed (0)
  4. docs/pt/docs/tutorial/metadata.md

    Mas você pode configurá-lo com o parâmetro `openapi_url`.
    
    Por exemplo, para defini-lo para ser servido em `/api/v1/openapi.json`:
    
    ```Python hl_lines="3"
    {!../../docs_src/metadata/tutorial002.py!}
    ```
    
    Se você quiser desativar completamente o esquema OpenAPI, pode definir `openapi_url=None`, o que também desativará as interfaces de documentação que o utilizam.
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Tue Oct 29 10:36:14 UTC 2024
    - 6.1K bytes
    - Viewed (0)
  5. docs/em/docs/how-to/extending-openapi.md

    ///
    
    📤 💼 🌐❔ 👆 💪 💪 🔀 🏗 🗄 🔗.
    
    👉 📄 👆 🔜 👀 ❔.
    
    ## 😐 🛠️
    
    😐 (🔢) 🛠️, ⏩.
    
    `FastAPI` 🈸 (👐) ✔️ `.openapi()` 👩‍🔬 👈 📈 📨 🗄 🔗.
    
    🍕 🈸 🎚 🏗, *➡ 🛠️* `/openapi.json` (⚖️ ⚫️❔ 👆 ⚒ 👆 `openapi_url`) ®.
    
    ⚫️ 📨 🎻 📨 ⏮️ 🏁 🈸 `.openapi()` 👩‍🔬.
    
    🔢, ⚫️❔ 👩‍🔬 `.openapi()` 🔨 ✅ 🏠 `.openapi_schema` 👀 🚥 ⚫️ ✔️ 🎚 & 📨 👫.
    
    🚥 ⚫️ 🚫, ⚫️ 🏗 👫 ⚙️ 🚙 🔢 `fastapi.openapi.utils.get_openapi`.
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 06 20:36:54 UTC 2024
    - 2.7K bytes
    - Viewed (0)
  6. docs/en/docs/how-to/extending-openapi.md

    A `FastAPI` application (instance) has an `.openapi()` method that is expected to return the OpenAPI schema.
    
    As part of the application object creation, a *path operation* for `/openapi.json` (or for whatever you set your `openapi_url`) is registered.
    
    It just returns a JSON response with the result of the application's `.openapi()` method.
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 27 22:39:38 UTC 2024
    - 3.1K bytes
    - Viewed (0)
  7. docs/de/docs/how-to/extending-openapi.md

    Als Teil der Erstellung des Anwendungsobjekts wird eine *Pfadoperation* für `/openapi.json` (oder welcher Wert für den Parameter `openapi_url` gesetzt wurde) registriert.
    
    Diese gibt lediglich eine JSON-Response zurück, mit dem Ergebnis der Methode `.openapi()` der Anwendung.
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 06 20:36:54 UTC 2024
    - 3.7K bytes
    - Viewed (0)
  8. fastapi/applications.py

                    )
            if self.openapi_url and self.redoc_url:
    
                async def redoc_html(req: Request) -> HTMLResponse:
                    root_path = req.scope.get("root_path", "").rstrip("/")
                    openapi_url = root_path + self.openapi_url
                    return get_redoc_html(
                        openapi_url=openapi_url, title=f"{self.title} - ReDoc"
                    )
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sat Aug 17 04:52:31 UTC 2024
    - 172.2K bytes
    - Viewed (0)
  9. docs/en/docs/release-notes.md

    * Remove obsolete vote link. PR [#1289](https://github.com/tiangolo/fastapi/pull/1289) by [@donhui](https://github.com/donhui).
    * Allow disabling docs UIs by just disabling OpenAPI with `openapi_url=None`. New example in docs: [Advanced: Conditional OpenAPI](https://fastapi.tiangolo.com/advanced/conditional-openapi/). PR [#1421](https://github.com/tiangolo/fastapi/pull/1421).
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Fri Nov 01 11:25:57 UTC 2024
    - 460.3K bytes
    - Viewed (0)
Back to top