在带有OpenApi3 + widdershins + shins的curl示例中,请求正文未显示

时间:2019-10-10 19:22:26

标签: api swagger openapi widdershins

我正在为我们的Java端点生成API文档。我正在使用widdershins将我们的openAPI3.0 yaml文件转换为markdown。然后,我正在使用shins将markdown文件转换为html。我们所有端点的请求正文都不会出现在生成的cURL示例中。为什么是这样?这样就无法使用cURL示例,因为复制和粘贴没有所需正文的cURL示例将不起作用。任何人都可以推荐一种解决方法或其他工具来生成具有完整cURL示例的良好文档吗?

openAPI.yaml文件中的示例端点...

post:
  tags:
  - Tools
  description: Installs a tool on a user's account
  operationId: Install Tool
  requestBody:
    description: UserTool object that needs to be installed on the user's account
    content:
      application/json:
        schema:
          $ref: '#/components/schemas/UserTool'
    required: true
  parameters:
  responses:
    default:
      description: default response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'

这是我们的工具链从此yaml文件生成的文档... enter image description here 我们想在cURL示例中添加一行,就像下面的一行(灰色突出显示)一样。这是Widdershins从我们的openAPI yaml文件生成的markdown文件中的一部分。我手动添加了“” d

enter image description here

此堆栈溢出问答表明,答案是不可能在使用swagger或openAPI的代码示例中包含body参数。它是否正确?如果是这样,为什么会这样呢?是什么原因?

干杯, 基甸

0 个答案:

没有答案