Wie Sie angeben, ob ein Feld optional oder erforderlich stolzieren?

Wie definiere ich in Fors, wenn ein Feld optional oder erforderlich und was ist der Standard?

InformationsquelleAutor user79074 | 2016-10-18

  1. 16

    Standardmäßig werden Felder in einem Modell sind optional, es sei denn, Sie legen Sie in die required Liste. Unten ist ein Beispiel - id, category sind optionale Felder, name erforderlich ist. Beachten Sie, dass required ist nicht ein Attribut der Felder, sondern ein Attribut des Objekts selbst - es ist eine Liste der erforderlichen Eigenschaften.

    type: object
required:  # List the required properties here
  - name
properties:
  id:
    type: integer
    format: int64
  category:
    $ref: '#/definitions/Category'
  name:
    type: string
    example: doggie

    Ref: https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/test/resources/2_0/petstore.yaml#L658

    Wenn das ist das Modell für den request-body, werden Sie wahrscheinlich auch brauchen, um zu markieren, den Körper selbst als required:

    # swagger: '2.0'

parameters:
  - in: body
    name: body
    required: true  # <----
    schema:
      $ref: '#/definitions/Pet'

# openapi: 3.0.1

requestBody:
  required: true  # <----
  content:
    ...

    Angeben, der default-Wert des optionalen Felder, die Sie verwenden können, die default Attribut. Hier ist ein Beispiel:

    type: object
properties:
  huntingSkill:
    type: string
    description: The measured skill for hunting
    default: lazy

    InformationsquelleAutor William Cheng

  2. 1

    Felder sind optional, sofern nicht als erforderlich markiert.

    Listen Sie die erforderlichen Felder aus wie diese:

    SomeObject:
    type: object
    required:
      - name
      - fartingPower
    properties:
      name:
        type: string
      fartingPower:
        type: integer
    Ich bin liebevoll die "fartingPower" - Eigenschaft.

    InformationsquelleAutor Bohdan

Schreibe einen Kommentar