@ogea12/api-types

@ogea12/api-types est un package permettant d'accéder à la description des types utilisés dans l'API de l'OGEA 12.

Premiers pas

Installation

Pour utiliser le package, vous devez d'abord l'intégrer dans votre projet.

npm install @ogea12/api-types

Utilisation

Ce dernier peut être ensuite couplé avec les librairies openapi-fetch et openapi-react-query afin de bénéficier d'un typage sûr et d'une autocomplétion améliorée pour éviter les erreurs syntaxiques.

import type { paths } from '@ogea12/api-types'

import createClient from 'openapi-fetch'

const client = createClient<paths>({
  baseUrl: 'https://test.ogea12.com/api',
  headers: {
    Accept: 'application/json',
  },
})

const {
  response,
  data, // Seulement présent avec une réponse 2XX
  error, // Seulement présent avec une réponse 4XX ou 5XX
} = await client.GET('/v1/auth/ping')