Construire une Application Todo List avec Go-Swagger : Un Guide Complet (2023)

Introduction

Dans ce guide, nous allons explorer de manière détaillée la construction d'une application Todo List en utilisant Go-Swagger. Cette plateforme offre une approche efficace pour développer des APIs bien structurées et faciliter la génération de code. Nous allons suivre pas à pas les étapes nécessaires pour créer un serveur et un client, en mettant l'accent sur les pièces clés de Go-Swagger.

Initialisation du Projet avec Swagger

La première étape consiste à initialiser le projet à l'aide de Swagger. En utilisant la commande swagger init, nous créons un fichier swagger.yml squelette qui sera la base de notre spécification. Cette spécification contient des informations essentielles telles que le titre de l'application, la description, la version, et les schémas de consommation et de production.

swagger: "2.0"
info:
  description: Du tutoriel Todo List sur goswagger.io
  title: Une application Todo List
  version: 1.0.0
consumes:
  - application/io.goswagger.examples.todo-list.v1+json
produces:
  - application/io.goswagger.examples.todo-list.v1+json
schemes:
  - http

Définition des Modèles et des Points d'Extrémité

Modèle d'Élément Todo

Dans notre spécification, nous définissons un modèle d'élément Todo avec des propriétés telles que l'identifiant, la description et l'état d'achèvement. Nous utilisons des annotations Swagger pour détailler ces informations, permettant ainsi une génération de code précise.

definitions:
  item:
    type: object
    required:
      - description
    properties:
      id:
        type: integer
        format: int64
        readOnly: true
      description:
        type: string
        minLength: 1
      completed:
        type: boolean

Point d'Extrémité pour Obtenir la Liste des Todos

Nous ajoutons une extrémité pour récupérer la liste des Todos. Cela inclut la définition des paramètres de requête tels que since et limit pour filtrer les résultats. Nous pensons à l'optimisation en ajoutant ces paramètres pour une expérience utilisateur flexible.

paths:
  /:
    get:
      tags:
        - todos
      parameters:
        - name: since
          in: query
          type: integer
          format: int64
        - name: limit
          in: query
          type: integer
          format: int32
          default: 20
      responses:
        200:
          description: Liste des opérations Todo
          schema:
            type: array
            items:
              $ref: "#/definitions/item"
        default:
          description: Réponse générique d'erreur
          schema:
            $ref: "#/definitions/error"

Génération du Code et Implémentation du Serveur

Après avoir défini notre spécification, nous générons le code du serveur en utilisant la commande swagger generate server. Cela crée une structure de fichiers organisée avec des fichiers de modèles, des opérations, et des configurations.

swagger generate server -A TodoList -f ./swagger.yml

Nous implémentons ensuite la logique de base du serveur en utilisant une carte Go pour stocker les éléments Todo. Chaque opération définie dans notre spécification est associée à une fonction de manipulation correspondante.

// La fonction de suppression d'un élément Todo
api.TodosDestroyOneHandler = todos.DestroyOneHandlerFunc(func(params todos.DestroyOneParams) middleware.Responder {
  delete(items, params.ID)
  return todos.NewDestroyOneNoContent()
})

Conclusion

Ce guide détaillé a couvert chaque étape de la construction d'une application Todo List avec Go-Swagger. De l'initialisation du projet à la génération du code et à la mise en œuvre du serveur, chaque détail a été abordé. En suivant ces instructions, vous pouvez créer une application robuste et bien documentée, prête à être déployée.

Notez que l'implémentation complète des opérations et la gestion des erreurs devront être réalisées pour obtenir une application pleinement fonctionnelle. Ce guide fournit la base solide sur laquelle construire votre application Todo List avec Go-Swagger.