Wie rekursive Pfade in OpenAPI/Swagger

Question

Ich möchte eine rekursive Spezifikation für meine Swagger API erstellen. Dieses Konzept scheint von the Swagger documentation abwesend zu sein, also vermute ich, dass es einfach nicht geht. Daher bin ich auch offen für alternative Lösungen, die von Swagger unterstützt werden.

Zum Beispiel versuche ich, eine Dokument-ähnliche Struktur zu erstellen. Jedes Dokument hat Abschnitte und jeder Abschnitt hat sowohl Text als auch eigene Abschnitte. Ich plane API Endpunkte wie diese auf mit:

• 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/ {Dokument-ID}/Abschnitt/{Abschnitt-ID}/Abschnitt/{Abschnitt-ID}/Abschnitt/{Abschnitt-ID}

Wenn ich wäre mit regex Stil, würde ich so etwas wie dies in der API-Spezifikation verwenden:

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

So sind die Fragen:

1. Wie repräsentiere ich willkürlich verschachtelt Ressourcen in einem Swagger/OpenAPI spec
2. Ist Gibt es eine alternative Methode, die rekursive Spezifikation überflüssig macht?

Answer 1

Ich würde ein einfacheres API-Design empfehlen. In einigen Unternehmen ist die Grenze maximal 2 Pfadparameter. Noch mehr und Sie stoßen an die Grenzen der Benutzerfreundlichkeit.