Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 10 for openapi_schema (0.27 sec)

  1. docs_src/extending_openapi/tutorial001_py39.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"] = {
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Wed Dec 17 20:41:43 UTC 2025
    - 737 bytes
    - Viewed (0)
  2. 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"
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Tue Jun 17 07:46:27 UTC 2025
    - 660 bytes
    - Viewed (0)
  3. tests/test_tutorial/test_extending_openapi/test_tutorial001.py

                    }
                }
            },
        }
        openapi_schema = response.json()
        # Request again to test the custom cache
        response = client.get("/openapi.json")
        assert response.status_code == 200, response.text
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Wed Dec 17 20:41:43 UTC 2025
    - 1.5K bytes
    - Viewed (0)
  4. tests/test_additional_responses_bad.py

    from fastapi.testclient import TestClient
    
    app = FastAPI()
    
    
    @app.get("/a", responses={"hello": {"description": "Not a valid additional response"}})
    async def a():
        pass  # pragma: no cover
    
    
    openapi_schema = {
        "openapi": "3.1.0",
        "info": {"title": "FastAPI", "version": "0.1.0"},
        "paths": {
            "/a": {
                "get": {
                    "responses": {
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Fri Jun 30 18:25:16 UTC 2023
    - 1.1K bytes
    - Viewed (0)
  5. docs/pt/docs/how-to/extending-openapi.md

    Ela apenas retorna uma resposta JSON com o resultado do método `.openapi()` da aplicação.
    
    Por padrão, o que o método `.openapi()` faz é verificar se a propriedade `.openapi_schema` tem conteúdo e retorná-lo.
    
    Se não tiver, ele gera o conteúdo usando a função utilitária em `fastapi.openapi.utils.get_openapi`.
    
    E essa função `get_openapi()` recebe como parâmetros:
    
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Wed Dec 17 20:41:43 UTC 2025
    - 3.6K bytes
    - Viewed (0)
  6. docs/ru/docs/how-to/extending-openapi.md

    Она просто возвращает JSON-ответ с результатом вызова метода приложения `.openapi()`.
    
    По умолчанию метод `.openapi()` проверяет свойство `.openapi_schema`: если в нём уже есть данные, возвращает их.
    
    Если нет — генерирует схему с помощью вспомогательной функции `fastapi.openapi.utils.get_openapi`.
    
    Функция `get_openapi()` принимает параметры:
    
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Wed Dec 17 20:41:43 UTC 2025
    - 4.9K bytes
    - Viewed (0)
  7. 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:
    
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Wed Dec 17 20:41:43 UTC 2025
    - 3.4K bytes
    - Viewed (0)
  8. tests/test_param_include_in_schema.py

    
    @app.get("/hidden_query")
    async def hidden_query(
        hidden_query: Optional[str] = Query(default=None, include_in_schema=False),
    ):
        return {"hidden_query": hidden_query}
    
    
    openapi_schema = {
        "openapi": "3.1.0",
        "info": {"title": "FastAPI", "version": "0.1.0"},
        "paths": {
            "/hidden_cookie": {
                "get": {
                    "summary": "Hidden Cookie",
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Tue Mar 26 16:56:53 UTC 2024
    - 7.4K bytes
    - Viewed (0)
  9. docs/es/docs/how-to/extending-openapi.md

    Simplemente devuelve un response JSON con el resultado del método `.openapi()` de la aplicación.
    
    Por defecto, lo que hace el método `.openapi()` es revisar la propiedad `.openapi_schema` para ver si tiene contenido y devolverlo.
    
    Si no lo tiene, lo genera usando la función de utilidad en `fastapi.openapi.utils.get_openapi`.
    
    Y esa función `get_openapi()` recibe como parámetros:
    
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Wed Dec 17 20:41:43 UTC 2025
    - 3.6K bytes
    - Viewed (0)
  10. docs/de/docs/how-to/extending-openapi.md

    Standardmäßig überprüft die Methode `.openapi()` die Eigenschaft `.openapi_schema`, um zu sehen, ob diese Inhalt hat, und gibt diesen zurück.
    
    Ist das nicht der Fall, wird der Inhalt mithilfe der Hilfsfunktion unter `fastapi.openapi.utils.get_openapi` generiert.
    
    Registered: Sun Dec 28 07:19:09 UTC 2025
    - Last Modified: Wed Dec 17 20:41:43 UTC 2025
    - 4K bytes
    - Viewed (0)
Back to top