Comment spécifier des chemins récursifs dans OpenAPI/Swagger

Question

Je voudrais créer une spécification récursive pour mon API Swagger. Ce concept semble être absent de the Swagger documentation, donc je soupçonne que ce n'est tout simplement pas possible. Je suis également ouvert à toutes les solutions alternatives supportées par Swagger. Par exemple, j'essaie de créer une structure semblable à un document. Chaque document comporte des sections et chaque section contient à la fois du texte et ses propres sections. Je prévois d'avoir points d'extrémité API comme celle-ci:

• http://a.b.com/docs/ {document-id}
• http://a.b.com/docs/ {document-id}/section/{section id}
• http://a.b.com/docs/ {document-id}/section/{section-id}/section/{section-id}
• http://a.b.com/docs/ {document-id}/section/{section-id}/section/{section-id}/section/{section-id}

Si j'étais en utilisant le style de regex, je voudrais utiliser quelque chose comme ça dans la spécification API:

...  
paths: 
    /docs/{document-id}: 
     get: 
      ... 
    /docs/{document-id}(/section/{section-id))+: 
     get: 
      ... 

Ainsi, les questions sont les suivantes:

1. Comment dois-je représenter des ressources arbitrairement imbriquées dans une spécification Swagger/OpenAPI
2. Est il existe une méthode alternative qui élimine le besoin de spécification récursive?

Answer 1

Je recommanderais une conception d'API plus simple. Dans certaines entreprises, la limite est un maximum de 2 paramètres de chemin. Rien de plus et vous repoussez la limite de la convivialité.