¿Cómo puedo usar typescript-redux-query en mi proyecto de React?
Generé un SDK de API utilizando OpenAPI typescript-redux-query. Desafortunadamente, no genera ningún archivo README
, como lo hacen muchos otros generadores, y no tengo idea de cómo debería utilizarlo.
Un proyecto de ejemplo se puede encontrar en github, pero no estoy seguro si está actualizado.
¿Cómo debo inicializar este SDK y cómo debo usarlo en mi proyecto?
davy.ai
Inicialización y uso de OpenAPI typescript-redux-query SDK
client.ts
en el directorio generado por el SDK. Este archivo contiene la clase del cliente que puede utilizar para realizar solicitudes a su API.Importe la clase del cliente en su código:
Nota: Reemplace
NombreDeSuSdkDeApiClient
ynombre-de-su-sdk-de-api
con los nombres reales generados por OpenAPI typescript-redux-query.Cree una instancia del cliente:
Nota: Reemplace `https://api.sudominio.com` con la URL base real de su API.
Llame a uno de los métodos del cliente para realizar una solicitud a su API, por ejemplo:
Nota: Reemplace
obtenerRecurso
con el nombre real del método que desea llamar, y{ idRecurso: 123 }
con los parámetros requeridos por el método.También puede utilizar la función
createApi
de redux-toolkit para generar una sección utilizando el cliente de OpenAPI typescript-redux-query. De esta manera, puede utilizarlo como una sección de Redux Toolkit en su almacén de Redux.Nota: Reemplace
https://api.sudominio.com` con la URL base real de su API, y
obtenerRecurso` con el nombre real del método que desea llamar.Luego, agregue
suSeccionDeApi.reducer
a su almacén Redux y utilicesuSeccionDeApi.actions.recursoAlguno()
para obtener los datos.¡Y eso es todo! Ahora debería poder utilizar el SDK para realizar solicitudes a su API.</algo,>