Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 122 for Documentation (0.23 sec)

  1. docs/fr/docs/tutorial/path-params.md

        On voit bien dans la documentation que `item_id` est déclaré comme entier.
    
    ## Les avantages d'avoir une documentation basée sur une norme, et la documentation alternative.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 10K bytes
    - Viewed (0)
  2. docs/en/docs/benchmarks.md

        * FastAPI provides more features on top of Starlette. Features that you almost always need when building APIs, like data validation and serialization. And by using it, you get automatic documentation for free (the automatic documentation doesn't even add overhead to running applications, it is generated on startup).
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 3.4K bytes
    - Viewed (0)
  3. docs/en/docs/alternatives.md

    It was one of the first examples of **automatic API documentation**, and this was specifically one of the first ideas that inspired "the search for" **FastAPI**.
    
    !!! note
        Django REST Framework was created by Tom Christie. The same creator of Starlette and Uvicorn, on which **FastAPI** is based.
    
    
    !!! check "Inspired **FastAPI** to"
        Have an automatic API documentation web user interface.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 23.2K bytes
    - Viewed (0)
  4. docs/en/docs/tutorial/path-params.md

        This is incredibly helpful while developing and debugging code that interacts with your API.
    
    ## Documentation
    
    And when you open your browser at <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>, you will see an automatic, interactive, API documentation like:
    
    <img src="/img/tutorial/path-params/image01.png">
    
    !!! check
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Fri Mar 22 01:42:11 GMT 2024
    - 9.1K bytes
    - Viewed (0)
  5. docs/en/docs/advanced/dataclasses.md

    And of course, it supports the same:
    
    * data validation
    * data serialization
    * data documentation, etc.
    
    This works the same way as with Pydantic models. And it is actually achieved in the same way underneath, using Pydantic.
    
    !!! info
        Keep in mind that dataclasses can't do everything Pydantic models can do.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 4.1K bytes
    - Viewed (0)
  6. docs/en/docs/tutorial/response-model.md

    FastAPI will use this `response_model` to do all the data documentation, validation, etc. and also to **convert and filter the output data** to its type declaration.
    
    !!! tip
        If you have strict type checks in your editor, mypy, etc, you can declare the function return type as `Any`.
    
        That way you tell the editor that you are intentionally returning anything. But FastAPI will still do the data documentation, validation, filtering, etc. with the `response_model`.
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 17.9K bytes
    - Viewed (0)
  7. docs/fr/docs/advanced/additional-responses.md

    Vous pouvez déclarer des réponses supplémentaires, avec des codes HTTP, des types de médias, des descriptions, etc.
    
    Ces réponses supplémentaires seront incluses dans le schéma OpenAPI, elles apparaîtront donc également dans la documentation de l'API.
    
    Mais pour ces réponses supplémentaires, vous devez vous assurer de renvoyer directement une `Response` comme `JSONResponse`, avec votre code HTTP et votre contenu.
    
    ## Réponse supplémentaire avec `model`
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 9.6K bytes
    - Viewed (0)
  8. docs/en/docs/tutorial/first-steps.md

    {"message": "Hello World"}
    ```
    
    ### Interactive API docs
    
    Now go to <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>.
    
    You will see the automatic interactive API documentation (provided by <a href="https://github.com/swagger-api/swagger-ui" class="external-link" target="_blank">Swagger UI</a>):
    
    ![Swagger UI](https://fastapi.tiangolo.com/img/index/index-01-swagger-ui-simple.png)
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu May 02 22:37:31 GMT 2024
    - 12K bytes
    - Viewed (0)
  9. docs/en/docs/tutorial/metadata.md

    * `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.
    
    ### Create metadata for tags
    
    Let's try that in an example with tags for `users` and `items`.
    
    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)
  10. docs/em/docs/tutorial/metadata.md

        * 👆 💪 ⚒ 🚮 📛 ⏮️ 🔢 `docs_url`.
        * 👆 💪 ❎ ⚫️ ⚒ `docs_url=None`.
    * **📄**: 🍦 `/redoc`.
        * 👆 💪 ⚒ 🚮 📛 ⏮️ 🔢 `redoc_url`.
        * 👆 💪 ❎ ⚫️ ⚒ `redoc_url=None`.
    
    🖼, ⚒ 🦁 🎚 🍦 `/documentation` &amp; ❎ 📄:
    
    ```Python hl_lines="3"
    {!../../../docs_src/metadata/tutorial003.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)
Back to top