Làm cách nào để tạo một trường theo định nghĩa bắt buộc đối với một số thao tác và không phải là một số hoạt động khác

Question

Tôi đang viết định nghĩa chữ thập trong yaml. Nói rằng tôi có một định nghĩa giống như thế này.

paths: 
    /payloads: 
    post: 
     summary: create a payload 
     ... 
     parameters: 
     - in: body 
     name: payload 
     description: New payload 
     required: true 
     schema: 
      $ref: "#/definitions/payload" 
    put: 
     summary: update a payload 
     ... 
     parameters: 
     - in: body 
     name: payload 
     description: Updated existing payload 
     required: true 
     schema: 
      $ref: "#/definitions/payload" 
... 
definitions: 
    payload: 
    properties: 
     id: 
     type: string 
     someProperty: 
     type: string 
     ... 

Có cách nào tôi có thể chỉ ra rằng thuộc tính id của tải trọng là bắt buộc cho thao tác PUT và không bắt buộc (hoặc hoàn toàn không xuất hiện) cho hoạt động POST?

Answer 1

Bạn sẽ phải xác định riêng các mô hình.

Tuy nhiên, bạn có các tùy chọn cho các trường hợp loại trừ và sự khác biệt.

Nếu bạn muốn loại trừ, đây là trường hợp dễ dàng, hãy tạo mô hình với thuộc tính bị loại trừ, hãy nói ModelA. Sau đó, xác định ModelB như ModelA cộng với additional property:

ModelB: 
    allOf: 
    - $ref: "#/definitions/ModelA" 
    - type: object 
     properties: 
     id: 
      type: string 

Nếu bạn đang tìm kiếm để xác định sự khác biệt, hãy làm theo phương pháp tương tự trên, và loại trừ id từ ModelA. Sau đó, hãy xác định ModelB và ModelC như mở rộng ModelA và thêm thuộc tính id vào chúng, mỗi thuộc tính có các hạn chế riêng. Theo bạn, JSON Schema có thể cho phép bạn làm theo ví dụ ban đầu ở trên cho một số trường hợp để "ghi đè" một định nghĩa. Tuy nhiên, vì nó không thực sự quan trọng, và người ta cần phải hiểu các khái niệm của Lược đồ JSON tốt hơn để không phạm sai lầm đơn giản, tôi khuyên bạn nên đi con đường này ngay bây giờ.