Produits Entr'ouvert » Passerelle

Mettre en valeur la méthode http

Pourquoi ?

Est-ce vraiment l'information la plus importante ?

(aussi, reléguer la description fonctionnelle, qui me semble bien plus utile, en bout à droite, pas ok)

(+ des détails qu'on verra plus tard)

C'est mignon j'aime bien, maintenant je ne sais pas à quel point on ne devrait pas juste produire du swagger plutôt que de le refaire en CSS, swagger c'est aussi les widgets pour tester les appels, c'est quand même bien pratique.

Frédéric Péters a écrit :

Est-ce vraiment l'information la plus importante ?

Je ne crois pas non plus, l'intérêt que j'y vois est plus de se rapprocher d'une présentation devenue 'standard' dans le domaine.

Benjamin Dauvergne a écrit :

Frédéric Péters a écrit :

Pourquoi ?
Est-ce vraiment l'information la plus importante ?

Je ne crois pas non plus

Pourquoi, ben pour savoir quelles méthode utiliser pour appeler le endpoint ... je ne comprends pourquoi vous tenez vous passer de cette information.

vous passer de cette information.

Mon commentaire concerne la mise en valeur excessive de l'information, façon "super je peux faire un GET, et en regardant tout à droite et en plissant les yeux je pourrai peut-être savoir ce que ce GET ferait".

Je soutiens ce ticket juste pour le coté uniformisation de la présentation qui donne une information explicite et non équivoque et les couleurs c'est sympa.

J'avais par erreur poussé (b8e84681fe277eb43bd972a4bcd480e0339d92a4) et reverté.
Donc je peux reprendre en intégrant la remarque: placer la description de l'endpoint à gauche et la méthode HTTP à droite.

Puis aussi prendre en compte les long_description, etc.

J'ai poussé #38276 si tu veux rebase et refaire un screenshot.

Les types sont stylés en gris et en italique normalement, tu n'as pas dû recharger ton css

En vrac.
Quelques améliorations graphiques possibles

1. Aligner les marges blanches sur celles du tableau "Sécurité" affiché en dessous.
2. Ne pas mettre l'information "Query parameters" en bold qui est une information redondante (et déjà mis en exergue par le fond blanc) mais plutôt la description de l'endpoint
3. Réduire l'espace de tabulation des paramètres
4. Aligner description & long-description sur le bloc blanc qui liste les paramètres
5. Ajouter un padding d'un espace mot au bloc blanc des paramètres
6. augmenter légèrement le margin entre les blocs endpoints
7. Caler le bloc .method-name "vraiment" en haut à gauche : sur la bordure du bloc
8. Uniformiser l'utilisation des doubles points pour les paramètres
9. Peut-être réduire l'impact visuel des blocs blanc parameters en ajoutant une opacité réduite.

Code CSS

1. Préférer em à px pour la gestion des espaces, basé sur le blanc typographique d'un espace mot (.33em ou .66em pour le double)
2. Retirer les tags des selecteurs
3. Préférer HSL pour les couleurs à la place de HEX permettrait de gagner en maintenance et mettre à jour plus simplement les couleurs
4. Vérifier si tout s'affiche bien en mobile : superposition methode / description; checker les line-height si affichage des textes en plusieurs lignes

:)

Je verrais bien le nom de la méthode mis en exergue et pas au même niveau que l'URL, via le même principe que la méthode HTTP, avec un encadré collé au coin gauche de la box (Récupérer / Liste / Remplacer), quand on arrive sur la page c'est l'information la plus importante.

Benjamin Dauvergne a écrit :

Je verrais bien le nom de la méthode mis en exergue et pas au même niveau que l'URL, via le même principe que la méthode HTTP, avec un encadré collé au coin gauche de la box (Récupérer / Liste / Remplacer), quand on arrive sur la page c'est l'information la plus importante.

Remarque de mon camarade Manu, pour une première version c'est très bien, oublie; Thomas J. repassera dessus et fera ça à sa sauce.