PGL/Clyde
PGL/Clyde
3
2
Fork 3
Code Issues 13 Pull Requests Actions Projects 3 Releases 2 Wiki Activity

RestApi Diagram général #2

New Issue
Closed
opened 2023-12-04 20:24:45 +01:00 by tonitch · 1 comment
tonitch commented 2023-12-04 20:24:45 +01:00
Owner
Copy Link

Je crois bien maîtriser openapi maintenant.

Dans les fait c'est juste un fichier yaml/json dans lequel on décrit toute nos entrées.

voici une première version (pas du tout fini) : 4788649163

Le but étant que vous puissiez avoir un aperçu et si ça vous donne des idées de les donner pendant la réalisation.

Donc en gros vu que c'est juste un yaml/json. On peut le passer dans différent outils pour produire différents résultats: notament

  • Server implémentation
  • Client implémentation
  • Tests
  • Documentation (ce qui nous intérésse)

Il y a beaucoup d'outils disponible pour la documentation: pour les préviews il suffit soit de donner le fichier yaml soit d'entrer un lien.
dans les deux cas vous avez l'addresse https://git.herisson.ovh/PGL/Clyde/raw/branch/master/Documents/proto/general/openapi.yaml qui peut être utilisée

Je crois bien maîtriser [openapi](https://spec.openapis.org/oas/latest.html) maintenant. Dans les fait c'est juste un fichier yaml/json dans lequel on décrit toute nos entrées. voici une première version (pas du tout fini) : https://git.herisson.ovh/PGL/Clyde/commit/4788649163defec400a2e36af13b84f60ee996ce Le but étant que vous puissiez avoir un aperçu et si ça vous donne des idées de les donner pendant la réalisation. Donc en gros vu que c'est juste un yaml/json. On peut le passer dans différent outils pour produire différents résultats: notament - Server implémentation - Client implémentation - Tests - Documentation (ce qui nous intérésse) Il y a beaucoup d'outils disponible pour la documentation: pour les préviews il suffit soit de donner le fichier yaml soit d'entrer un lien. dans les deux cas vous avez l'addresse `https://git.herisson.ovh/PGL/Clyde/raw/branch/master/Documents/proto/general/openapi.yaml` qui peut être utilisée - [ReDoc](https://redocly.github.io/redoc/?url=https%3A%2F%2Fgit.herisson.ovh%2FPGL%2FClyde%2Fraw%2Fbranch%2Fmaster%2FDocuments%2Fproto%2Fgeneral%2Fopenapi.yaml&nocors=#tag/users) - [elements](https://elements-demo.stoplight.io/?spec=https%3A%2F%2Fgit.herisson.ovh%2FPGL%2FClyde%2Fraw%2Fbranch%2Fmaster%2FDocuments%2Fproto%2Fgeneral%2Fopenapi.yaml#/schemas/Address) - [swagger ui](https://petstore.swagger.io/) - [lucybot](http://demo.lucybot.com/#/documentation/API_Description) (pas de live preview mais un example est dispo - [DapperDox](http://dapperdox.io/) (pas de preview je pense) - [mermade](https://mermade.github.io/reslate/#introduction) (pas de live preview mais un example est dispo)
Wal was assigned by tonitch 2023-12-04 20:24:45 +01:00
tonitch self-assigned this 2023-12-04 20:24:45 +01:00
Maxime commented 2023-12-07 10:49:11 +01:00
Owner
Copy Link

Il y a des erreurs dans le code que tu as fourni en exemple avec {id}

Il y a des erreurs dans le code que tu as fourni en exemple avec {id}
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels   
Bug

   
Done

finie, en attente de validation pour ou pret à la fermeture

  
Pas urgent

A faire que si on a le temps

  
Proposition

   
Question

   
TODO

   
Tests

   
URGENT BORDEL DE Q

   
Waiting for review

   
back

   
front
No Label
Bug
Done
Pas urgent
Proposition
Question
TODO
Tests
URGENT BORDEL DE Q
Waiting for review
back
front
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
tonitch
Wal
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: PGL/Clyde#2
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?