Wie wird der Datentyp datatypes.JSON von go in der openAPI-Spezifikation beschrieben?

Der PHP-Editor Baicao stellt Ihnen vor, wie der Datentyp datatypes.JSON von go in der openAPI-Spezifikation beschrieben wird. In der openAPI-Spezifikation wird Schema Object zur Beschreibung von Datentypen verwendet. Der Datentyp datatypes.JSON in go kann mit dem Typ „string“ und dem Format „json“ beschrieben werden. Dadurch können Sie den Datentyp des Felds explizit als Zeichenfolge im JSON-Format angeben. Darüber hinaus kann das Beispielfeld auch zur Bereitstellung von Beispielwerten verwendet werden, um Entwicklern ein besseres Verständnis der Struktur und Verwendung des Datentyps zu erleichtern. Durch die sinnvolle Verwendung der openAPI-Spezifikation kann der Datentyp datatypes.JSON in go genau beschrieben werden, wodurch Entwickler klare Schnittstellendokumente und Datentypdefinitionen erhalten.

Frageninhalt

Ich habe ein Golang-Gin-Projekt. Es gibt eine solche Struktur:

type Value struct { 
    gorm.Model 
    QuesAns       datatypes.JSON json:"ques_ans" 
}

Das Feld

QuesAns sollte JSON eines dieser drei Typen enthalten.

"ques_ans": {
    "receiver.ques": [
         "Q1",
         "Q2"
     ], 
    "receiver.ans": [
         "Ans1",
         "Ans2",
         "Ans3" 
     ]
 }

"ques_ans": {
     "id": "1",
     "receiver.sid": "2743dfjfh87",
     "receiver.ques": [
         "Q1",
         "Q2",
         "Q3" 
     ] 
 }

"ques_ans": {
     "receiver.ques_key": [
         "1",
         "2" 
     ],
     "receiver.ans_key": [
         "13",
         "20" 
     ] 
 }

Wie würden Sie die Integration der Open API-Spezifikation beschreiben?

Ich habe mehrere Typen ausprobiert, konnte sie aber nicht alle synchronisieren, da JSON verschiedene Typen haben kann und nur diese drei Typen funktionieren.

Lösung

Okay! So habe ich es gelöst:

components:
  schemas:
    Value:
      type: object
      properties:
        ques_ans:
          oneOf:
            - $ref: '#/components/schemas/Type1'
            - $ref: '#/components/schemas/Type2'
            - $ref: '#/components/schemas/Type3'
    Type1:
      type: object
      properties:
        receiver.ques:
          type: array
          items:
            type: string
        receiver.ans:
          type: array
          items:
            type: string
    Type2:
      type: object
      properties:
        id:
          type: string
        receiver.sid:
           type: string
        receiver.ques:
          type: array
          items:
            type: string
    Type3:
      type: object
      properties:
        receiver.ques_key:
          type: array
          items:
            type: string
        receiver.ans_key:
          type: array
          items:
            type: string

Das obige ist der detaillierte Inhalt vonWie wird der Datentyp datatypes.JSON von go in der openAPI-Spezifikation beschrieben?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!