【问题标题】:Swagger API description should NOT have additional propertiesSwagger API 描述不应该有额外的属性
【发布时间】:2021-04-01 11:19:06
【问题描述】:

我有如下所述的招摇 API 描述 (yaml / v 3.0)。我得到错误 路径结构错误。/AanwezigLeden/Aanmelden.post.requestBody.content.application/json.schema 不应该有额外的属性 附加属性:allOff

我想要的是一个 post 方法的 API 描述,其对象指定为 oper_aanwezig_leden,另外还有一个字段作为主体。

    /AanwezigLeden/Aanmelden:
        post:
          summary: Aanmelden van het lid als aanwezig. 
          requestBody:
            description: Lid data
            required: true
            content:
              application/json:
                schema:
                  allOff:
                  - ref: '#/components/schemas/oper_aanwezig_leden' 
                  - type: string
                    name: TIJDSTIP
                    description: Tijdstip van de aanmelding. Indien afwezig, huidige tijd. ISO8601
                    required: false
          responses:
            200:
              description: "OK, data succesvol aangepast"
              content:
                application/json:
                  schema:
                    $ref: '#/components/schemas/oper_aanwezig_leden' 
            401:
              description: "Niet geautoriseerd, geen schrijfrechten"  
            404:
              description: "Data niet gevonden"        
            405:
              description: "Methode niet toegestaan, input validatie error"  
            406:
              description: "Niet aanvaardbaar, input ontbreekt"            
            500:
              description: "Data verwerkingsfout, bijv onjuiste veldwaarde (string ipv integer)" 

【问题讨论】:

  • 错字:allOff -> allOf

标签: swagger openapi


【解决方案1】:

这促使我解决了这个问题。但是,这里不仅仅是一个错字

  /AanwezigLeden/Aanmelden:
    post:
      summary: Aanmelden van het lid als aanwezig. 
      requestBody:
        description: Lid data
        required: true
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/oper_aanwezig_leden_in' 
              - type: object
                properties:
                  TIJDSTIP:
                    description: Tijdstip van de aanmelding. Indien afwezig, huidige tijd. ISO8601
                    type: string
                    format: date-time 
                    example: "2017-07-21T09:32:28Z"   

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2021-12-11
    • 1970-01-01
    • 2016-11-06
    • 2019-11-02
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多