Swagger :: documentation interactive pour vos services Web

Tutoriel vidéo : une introduction à Swagger

Le code PHP pour votre projet Laravel 5

Cette section présente le code PHP Laravel pour les classes suivantes :

  • Controller.php
  • StationController.php
  • PostStationRequest.php
  • StationResource.php

Portez une attention particulière aux commentaires qui comportent des annotations qui serviront à la création de la documentation interactive Swagger.

Le projet utilisé se nomme L5-Swagger (Swagger pour Laravel 5).

La classe contrôleur de base

Nous définissons les paramètres de base pour la documentation interactive.

 

Contrôleur pour la gestion de stations d’analyse de qualité de l’air

Ici, 2 routes sont définies. Une route GET et une autre POST. Notez que la route POST est protégée par un security scheme.

 

Définition d’une classe de validation FormRequest

Cette section permet de définir les règles de validation pour notre requête POST.

Ressource ou structure des données retournées au client

La classe StationResource permet de définir les données qui seront retournées au client.

 

 

 

Comments

comments

1 réponse

Laisser un commentaire

Participez-vous à la discussion?
N'hésitez pas à contribuer!

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *

Ce site utilise Akismet pour réduire les indésirables. En savoir plus sur comment les données de vos commentaires sont utilisées.