Exile on Keyboard St. - Blog sur Linux et Debian

Aller au contenu | Aller au menu | Aller à la recherche

dimanche 9 septembre 2018

Tester une API REST directement depuis le Swagger Hub

Les moyens de tester une API REST ne manquent pas.

Mais pendant que l'on définit celle-ci, si on le fait avec le Swagger Hub, il n'est vraiment pas besoin de se compliquer la vie.

En effet, le Swagger Hub qui permet de définir le fichier yaml ou json de l'API, mais aussi de générer les stubs clients et/ou serveur de l'API permet aussi de tester une installation de ladite API.

Il suffit pour cela de:

  1. Se rendre sur la page de votre API, par exemple: https://app.swaggerhub.com/apis/<user>/<api>/<api-version>
  2. Renseigner le nom du serveur de test qui "hoste" votre API
  3. Installer l'Add-On pour Firefox CORS Everywhere afin que le Swagger Hub puisse contacter votre serveur de test
  4. Sélectionner en bas à droite de l'écran l'option: "Routing requests via browser"
  5. Cliquer sur l'URL voulue puis sur "Try it out"
  6. Remplir les champs et enfin cliquer sur "Execute"

De cette façon, vous pouvez faire très facilement des tests manuels sur la permière version de votre API et éventuellement de corriger les problèmes. Et vous n'avez écrit ni généré aucun code pour ce faire !

lundi 6 août 2018

Java: Bien utiliser le Builder pattern

Quand on maintient du code Java, on tombe malheureusement assez souvent sur des méthodes aux signatures complexes comme celle-ci:

public int myMethod(String id, String name, Boolean secure, Object obj, Object backupObj, boolean restart)

Et il n'est pas rare d'avoir encore plus de paramètres !

La situation se dégrade encore quand pour "simplifier", on surcharge la méthode précédente en:

public int myMethod(String id, String name, Boolean secure, Object obj, Object backupObj)

quand restart vaut false puis en:

public int myMethod(String id, String name, Boolean secure, Object obj)

quand en plus backupObj est null.

On peut avoir ainsi 3 à 5 signatures différentes pour la même méthode. Et cela devient vite unsupportable quand on veut refactorer ces méthodes, parce qu'elles sont référencées n fois dans le code de production et également dans les tests.

Si le développeur qui a créé la première méthode avait créé un object et l'avait passé en paramètre de sa méthode, on n'en serait pas là !

Imaginons maintenant la méthode suivante qui permet de créer un utilisateur:

public long create(final String firstName, final String name, final int age)

Elle retourne l'identifiant de l'utilisateur créé. Supposons que l'age n'est pas obligatoire et que l'on souhaite anticiper l'ajout de nouveaux champs pour créer un utilisateur.

On va alors plutôt procéder comme suit:

public long create(final User user)

La classe User commencera comme ceci:

public class User
{
    private long id;
    private String firstName;
    private String lastName;
    private int age;
}

Mais pour créer un utilisateur à passer en paramètre de la méthode create, on va créer un Builder pour construire l'objet User.

Pour cela, on peut installer le Plugin Builder Generator. Un autre plugin est également disponible: Inner Builder.

Après redémarrage d'IDEA, un clic-droit puis Generate propose maintenant l'option "Builder" et on a alors la boite de dialogue suivante:

Capture-CreateBuilder.png

Ici on a choisi un "innerBuilder" afin que le Builder soit une classe interne de l'objet lui même.

On choisit ensuite la liste des champs à inclure, on ne prends pas l'id puisqu'il ne sera pas calculé par l'appelant de la méthode create mais bien par celle-ci:

Capture-Select_Fields_to_Be_Available_in_Builder.png

Et on obtient:


    public static final class UserBuilder
    {
        private String firstName;
        private String lastName;
        private int age;

        private UserBuilder()
        {
        }

        public static UserBuilder anUser()
        {
            return new UserBuilder();
        }

        public UserBuilder withFirstName(String firstName)
        {
            this.firstName = firstName;
            return this;
        }

        public UserBuilder withLastName(String lastName)
        {
            this.lastName = lastName;
            return this;
        }

        public UserBuilder withAge(int age)
        {
            this.age = age;
            return this;
        }

        public User build()
        {
            User user = new User();
            user.lastName = this.lastName;
            user.age = this.age;
            user.firstName = this.firstName;
            return user;
        }
    }

On crée ensuite notre User comme suit:

        final User user = UserBuilder
                    .anUser()
                    .withFirstName("Brian")
                    .withLastName("Kernighan")
                    .build();

Cette façon de faire permet:

  • de faire évoluer l'objet User en changeant un minimum de code
  • de valider les différents champs dans la méthode build

Et les signatures des méthodes ne changent pas.

On peut même éviter de dupliquer les champs de la classe User dans la classe UserBuilder en procédant comme ceci:

public static final class UserBuilder
    {
        private User user;

        private UserBuilder()
        {
            user = new User();
        }

        public static UserBuilder anUser()
        {
            return new UserBuilder();
        }

        public UserBuilder withFirstName(String firstName)
        {
            this.user.firstName = firstName;
            return this;
        }

        public UserBuilder withLastName(String lastName)
        {
            this.user.lastName = lastName;
            return this;
        }

        public UserBuilder withAge(int age)
        {
            this.user.age = age;
            return this;
        }

        public User build()
        {
            return user;
        }
    }

Mais notre générateur ne sait pas le faire :-(

samedi 14 juillet 2018

Changer les serveurs DNS utilisés par la Freebox

J'ai (j'avais) souvent des problèmes de lenteur sur Internet avec la Freebox.

Après recherche, il s'est avéré que ce problème provenait du temps de réponse du serveur DNS.

Comme par défaut, le serveur DNS utilisé avec une Freebox est celui de la Freebox elle même, j'ai changé la valeur: 192.168.0.254, qui est l'adresse du boitier freebox server, avec les valeurs des serveurs DNS fournis par un fournisseur d'accès à Internet associatif, à savoir FDN.

Ces valeurs sont les suivantes:

  • 80.67.169.12
  • 80.67.169.40

Capture-Informations_sur_la_connexion.png

Et de cette façon, je n'ai plus de soucis avec mes requêtes DNS !

Serveurs DNS de FDN

- page 1 de 53