比方說,我有一個用戶模型定義:id,first_name,last_name,created_at,我有一個在swagger中的對象定義。如何在帖子請求中放棄對象字段
創建用戶的POST請求會期望first_name和last_name。我怎麼會寫這個在搖擺? Swagger期望一個單一的對象應該爲此創建一個新的對象嗎?
比方說,我有一個用戶模型定義:id,first_name,last_name,created_at,我有一個在swagger中的對象定義。如何在帖子請求中放棄對象字段
創建用戶的POST請求會期望first_name和last_name。我怎麼會寫這個在搖擺? Swagger期望一個單一的對象應該爲此創建一個新的對象嗎?
您可以將first_name
,last_name
標記爲必填字段。下面是一個例子:
required:
- first_name
- last_name
(換句話說,沒有必要創建一個單獨的對象)
但它仍然會在文檔中引起混淆。我更多地指出,當我有一個用戶對象時,在創建用戶時會生成一個「id」字段。發佈請求會期望沒有「id」的「用戶」對象。如果我將「id」標記爲不需要,那麼API的用戶可能會認爲「id」是可選的並傳遞它 – EugeneMi
如何
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
和
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
您是否找到我回答有幫助,還是需要進一步幫助? –