Par Valentin Brosseau / @c4software
GET /v1/capteursUne seule route, mais toute la structure : les couches, les migrations, Koin.
| Verbe | Chemin | Action |
|---|---|---|
GET |
/v1/capteurs/{id} |
Obtenir |
POST |
/v1/capteurs |
Créer |
PUT |
/v1/capteurs/{id} |
Modifier |
DELETE |
/v1/capteurs/{id} |
Supprimer |
Le CRUD complet.
Pour chaque opération, toujours le même chemin :
DAO, puis service, puis route.
Le client demande le capteur numéro 99.
Il n'existe pas. Que doit répondre l'API ?
| Code | Signification |
|---|---|
200 |
Succès |
201 |
Ressource créée |
204 |
Succès, rien à renvoyer |
400 |
Requête invalide |
404 |
Ressource inexistante |
Le code dit ce qui s'est passé, avant même de lire la réponse.
class ApiException(val status: HttpStatusCode, message: String) : Exception(message)N'importe quelle couche lève l'exception.
Le plugin StatusPages la transforme en réponse HTTP.
{ "message": "Le capteur 99 n'existe pas" }Géré à un seul endroit, pas dans chaque route.
Un 500, avec un message générique. Le détail part dans les logs.
Ne jamais révéler une erreur interne au client.
post {
val request = call.receive<SensorRequest>()
call.respond(HttpStatusCode.Created, sensorService.create(request))
}Ce que l'API reçoit n'est pas ce qu'elle renvoie : l'id, c'est la base qui le choisit.
"name": 42 est refusé automatiquement.
Et "name": "" ?
require(name.isNotBlank()) { "Le nom est obligatoire" }Une seconde ressource, les salles, cette fois sans pas-à-pas.
La même recette : migration, table, DAO, service, module, routes.
Votre API est en ligne.
Qui peut supprimer tous les capteurs ?
Il suffit de connaître son adresse.
| Question | Nom | Échec |
|---|---|---|
| Qui êtes-vous ? | Authentification | 401 |
| En avez-vous le droit ? | Autorisation | 403 |
Authorization: Bearer cle-lecteurUne chaîne secrète, envoyée à chaque requête.
En base, on ne garde que son empreinte (SHA-256), jamais la clé en clair.
cle_api ──► role ──► permission (ressource, action)authenticate("api-key") {
withPermission("capteurs", Action.DELETE) {
delete("/{id}") {
sensorService.delete(call.requireId())
call.respond(HttpStatusCode.NoContent)
}
}
}En lisant le fichier, on voit qui peut faire quoi.
Le technicien tente un DELETE.
401 ou 403 ?
On sait qui il est, mais c'est interdit.
Le code de la route n'est jamais exécuté : aucun capteur n'est supprimé.
401) : qui êtes-vous ?403) : un rôle, une ressource, une action.Place au TP 🚀