Gibt es einen Trick mit dem Components-Objekt, mit dem ich $ Ref ein häufig verwendetes Objekt Beschreibung kann?

Question

Ich wiederhole eine Beschreibung immer wieder innerhalb eines requestbody> content. Ich suchte nach einer DRY-Technik in der OpenAPI v3-Spezifikation, in der ich einen $ Ref verwenden könnte, um die Dinge zu vereinfachen. Nichts sprang auf mich. Also dachte ich, ich würde die Experten hier fragen, ob sie einen Weg kennen.

Answer 1

Ist es rein die Beschreibung, die wiederholt, oder ein Unterabschnitt Ihres requestBody Content-Schemas? Wenn der erste, Sie können einfach Ihr Schema in Sub-Schemas und $ref ihnen aufgliedern. Wenn letzteres ...

Als description ist eine String-Eigenschaft nicht ein Objekt, kann es nicht durch ein $ref ersetzt werden, aber Sie können das allOf Schema Schlüsselwort verwenden, um Schemata zu kombinieren:

allOf: 
    - $ref: '#/components/schemas/myDescription' 
    - ... # other schema properties 

und in Ihrem components/schemas:

myDescription: 
    description: 'Re-usable description here'