---
id: openapi
title: API OpenAPI
sidebar_label: OpenAPI
description: Documentation interactive de l'API Veza
keywords: [veza, api, openapi, swagger, documentation]
---

# 📡 API OpenAPI

Documentation interactive de l'API Veza Platform.

## 🎯 Vue d'Ensemble

L'API Veza est documentée avec **OpenAPI 3.0** et accessible via :
- **Swagger UI** : Interface interactive
- **ReDoc** : Documentation alternative
- **Postman** : Collection importable
- **Insomnia** : Workspace partagé

## 🔗 Accès à la Documentation

### Swagger UI
- **URL** : `/api/docs`
- **Description** : Interface interactive complète
- **Fonctionnalités** : Test des endpoints, schémas, exemples

### ReDoc
- **URL** : `/api/redoc`
- **Description** : Documentation alternative
- **Fonctionnalités** : Vue hiérarchique, recherche

## 📋 Endpoints Principaux

### Authentification
- `POST /api/auth/login` - Connexion
- `POST /api/auth/register` - Inscription
- `POST /api/auth/refresh` - Renouvellement token
- `POST /api/auth/logout` - Déconnexion

### Utilisateurs
- `GET /api/users` - Liste des utilisateurs
- `GET /api/users/{id}` - Profil utilisateur
- `PUT /api/users/{id}` - Mise à jour profil
- `DELETE /api/users/{id}` - Suppression utilisateur

### Audio
- `GET /api/audio` - Liste des fichiers
- `POST /api/audio/upload` - Upload fichier
- `GET /api/audio/{id}` - Détails fichier
- `DELETE /api/audio/{id}` - Suppression fichier

### Chat
- `GET /api/chat/rooms` - Liste des salons
- `POST /api/chat/rooms` - Créer un salon
- `GET /api/chat/rooms/{id}/messages` - Messages du salon
- `POST /api/chat/rooms/{id}/messages` - Envoyer un message

## 🔧 Configuration

### OpenAPI Specification
```yaml
openapi: 3.0.0
info:
  title: Veza Platform API
  version: 1.0.0
  description: API pour la plateforme de streaming audio et chat
servers:
  - url: https://api.veza.com
    description: Production
  - url: https://staging-api.veza.com
    description: Staging
```

### Swagger UI Configuration
```yaml
swagger_ui:
  title: "Veza Platform API"
  description: "Documentation interactive de l'API"
  version: "1.0.0"
  contact:
    name: "Équipe Veza"
    email: "dev@veza.com"
  license:
    name: "MIT"
    url: "https://opensource.org/licenses/MIT"
```

## 🚀 Utilisation

### Test des Endpoints
1. Ouvrir Swagger UI
2. Cliquer sur "Authorize"
3. Entrer le token JWT
4. Tester les endpoints

### Import Postman
1. Télécharger la collection
2. Importer dans Postman
3. Configurer les variables d'environnement
4. Tester les requêtes

## 📚 Documentation

- [Backend Go API](/docs/backend/go-api)
- [Guide de Développement](/docs/meta/contributing-docs)