Wie man Objektfelder von einer Beitragsanfrage in swagger

Question

weglässt Lassen Sie mich sagen, ich habe ein Benutzermodell definiert mit: ID, Vorname, Nachname, erstellt_at, und ich habe eine Objektdefinition dafür in Swagger.

Eine POST-Anfrage zum Erstellen eines Benutzers würde first_name und last_name erwarten. Wie würde ich das in Swagger schreiben? Swagger erwartet ein einzelnes Objekt für das Soll ich ein neues Objekt nur für das erstellen?

Answer 1

Sie können first_name, last_name als erforderliche Felder markieren. Hier ein Beispiel:

required: 
    - first_name 
    - last_name 

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

(in anderen Worten, keine Notwendigkeit, ein separates Objekt erstellen)

Answer 2

Wie wäre es

myuser: 
    allOf: 
    - $ref: '#/definitions/myuserbase' 
    - type: object 
    properties: 
     id: 
     description: | 
      Unique identifier for the classifier. 
     type: string 
     example: user1 
     created_at: 
     description: | 
      Date and time the user was created. 
     type: string 
     format: date-time   
    required: 
     - id 

und

myuserbase: 
    type: object 
    properties: 
     first_name: 
     description: | 
      First name of the user 
     type: string 
     last_name: 
     description: | 
      Last name of the user 
     type: string 
    required: 
     - first_name 
     - last_name