Query Parameters

In this moment we can see the Query Parameter than it is a good way to pass parameters without obligatory

In the follow we see this:

"/tweets/{tweet_id}/details?age=30&height=184"

where age and height are the query parameters and tweet_id is path parameter

Query Parameters:
Un Query Patameter es un conjunto de elementos opcionales los cuales son añadidos al finalizar la ruta, con el objetivo de definir contenido o acciones en la url,
estos elementos se añaden despues de un ?
para agregar más query parameters utilizamos &

Query Parameters

Query parameters: son un conjunto definido de parámetros adjuntos al final de una URL . Son extensiones de la URL que se utilizan para ayudar a definir contenido o acciones específicos en función de los datos que se transmiten.

Documentación Oficial:
https://fastapi.tiangolo.com/tutorial/query-params/

Mis Apuntes:
https://hackmd.io/@EY-75X2IS6-Sv0wXHoIR0Q/rk8vjxCrt#Query-Parameters

Un ejemplo de Query Parameters:

https://www.youtube.com/results?search_query=query+parameters

Un ejemplo de cómo funcionan los query parameters:

https://www.youtube.com/results?search_query=los+query+parameters+en+FastAPI

Ahora eliminando lo que viene luego del signo"?":

https://www.youtube.com/results? # dale a la tecla "Enter"

Efectivamente SIGUE FUNCIONANDO

Query Parameters 💯

.

1. Parámetros opcionales para nuestros Endpoints.

2. Estos nos pueden ser de utilidad al momento de aplicar búsquedas o filtros del recurso que le devolveremos a los usuarios de nuestra API 🙌.

3. Para indicar que comenzaremos a agregar un query parameter usamos el símbolo de interrogación ? seguido del nombre del campo con el valor a aplicar.

4. Si necesitas mandar más de un parámetro opcional no te preocupes, lo único que tienes que hacer es concatenar el símbolo de &y agregar más parámetros.

#For example, in the URL: 
http://127.0.0.1:8000/items/?skip=0&limit=10
/users/{user_id}/details/**?age=20&height=184**

En muchos casos si uno elimina los parámetros opcionales la página continuará funcionando pero en muchas ocasiones esta también va a cambiar en algunos aspectos.
Por ejemplo es normal ir quitando parametros en una URL de imagen y obtener la misma pero en distintas calidades

Path

Path parameters

Un path parameter es una variable incluida en la URL.

• Obligatorios
• Van entre llaves { }
• Ejemplo https://twitter.com/users/{tweet_id}

Query Parameters

El query es el conjunto de pares de key-value que van después del ? en la URL y separados por caracteres &.

• Opcionales
• Empiezan por ?, si hay más de uno se unen usando &
• Ejemplo https://platzi.com/search/?search=Python&filter=material-lecture

Query Parameters

Son Path Parameters opcionales inician con ? y se concatena con &.
Cuando se declaran otros parámetros de la función que no forman parte de los parámetros de la ruta, se interpretan automáticamente como Query Parameters.

No son una parte fija de una ruta, pueden ser opcionales y pueden tener valores por defecto.
Puedes declarar varios Paths Parameters y Query Parameters al mismo tiempo, FastAPI sabe cuál es cada uno.
Y no tienes que declararlos en ningún orden específico. Serán detectados por su nombre.

from typing import Optional

from fastapi import FastAPI

app = FastAPI()



@app.get("/users/{user_id}/items/{item_id}")

async def read_user_item(

    user_id: int, item_id: str, q: Optional[str] = None, short: bool = False

):
    item = {"item_id": item_id, "owner_id": user_id}
    if q:
        item.update({"q": q})
    if not short:
        item.update(
            {"description": "This is an amazing item that has a long description"}
        )
    return item

No puedo dejar de mirar todas las URL de la páginas a las que entro. Fascinante poder entenderlas. Gracias Facu!!

Query Parameters:
Son elementos opcionales que se encuentran en nuestra ruta
Para agregar estos elementos debemos de poner: ‘?’

En caso de querer usar mas de un elemento opcional se pueden unir con ‘&’

User -> método PUT => /users/{user_id}/details?age=20&name=Juan

Usando los ‘?’ usamos los query parameters y con el ‘&’ usamos varios al mismo tiempo.

Query parameters:
Conjunto de propiedades y su valor, de un modelo que pueden pasarse opcionalmente al final de un path, comenzado con ? , definiendolo con propiedad=valor, agregando otros con &

Query Parameters == Path NO obligatorio

/user/{user_id}/details?age=20&weight=190

Luego del “?” es información NO obligatoria y con el símbolo “&” uno esos Query Parameters.

muy interesante