Référence

Format de collection

Tous les champs YAML supportés par les collections, environnements et requêtes.

# requests/*.yml

Champ	Type	Description
`name`	string	Nom affiché.
`kind`	`http \| graphql \| ws \| sse \| grpc`	Nature de la requête. Défaut : http.
`method`	string	Méthode HTTP.
`url`	string	URL avec variables.
`query`	KeyValue[]	Paramètres query activables.
`pathParams`	KeyValue[]	Variables de chemin documentées.
`headers`	KeyValue[]	Headers activables.
`body`	Body	json, raw ou form.
`graphqlVariables`	string JSON	Variables GraphQL.
`grpcService`	string	Service gRPC complet.
`grpcMethod`	string	Méthode gRPC.
`scripts`	Scripts	preRequest et tests QuickJS.
`docs`	string Markdown	Description de l’endpoint.

Requête complète

name: Créer une session
kind: http
method: POST
url: "{{baseUrl}}/auth/login"
headers:
  - key: Content-Type
    value: application/json
    enabled: true
body:
  type: json
  content: |
    {
      "email": "{{email}}",
      "password": "{{secret:API_PASSWORD}}"
    }
scripts:
  tests: |
    test("session créée", () => expect(res.status).toBe(200))
    test("token présent", () => expect(res.json.accessToken).toBeDefined())
docs: |
  Authentifie un utilisateur de test et expose un jeton pour la suite.

# KeyValue

Entrée KeyValue

- key: X-Request-Id
  value: "{{traceId}}"
  enabled: true
  description: Identifiant corrélé aux logs serveur