首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >回送4:在API调用中添加参数

回送4:在API调用中添加参数
EN

Stack Overflow用户
提问于 2019-07-07 09:19:36
回答 2查看 1.8K关注 0票数 0

我是新的回圈4 (NodeJS),我有一个问题。我正在开发一个API。如何指示post请求正文中未定义为模型的参数?

示例:

代码语言:javascript
复制
@post('/gameshits/{id}', {
    responses: {
      '200': {
        description: 'Return the number of correct answers',
      },
    },
  })
  async gamesHits(
    @param.path.string('id') id: string,
    @requestBody() answers: Array<String>,
  ): Promise<number> {
     ....
}

问题在于requestBody()它的编译,但是在环回/资源管理器中说它可以呈现。唯一的选择是创建一个模型?如何添加更多的参数来发送调用的主体?(不像@param do那样在url中)

谢谢。

EN

回答 2

Stack Overflow用户

回答已采纳

发布于 2019-08-15 20:05:01

不,您不需要创建一个模型来指示参数,实际上它非常容易,但是没有太多的文档。

你可以指出类似的事情。

代码语言:javascript
复制
@post('/gameshits/{id}', {
  responses: {
    '200': {
      description: 'Return the number of correct answers',
    },
  },
})
async gamesHits(
  @param.path.string('id') id: string,
  @requestBody({
    content: {
      'application/json': {
        type: 'object',
        schema: {
          properties: {
            gameName: {type: 'string'},
            characters: {
              type: 'array',
              items: {
                properties: {
                  name: {type: 'number'},
                  power: {type: 'number'},
                  cost: {type: 'number'},
                  ability: {type: 'string'}
                },    
              },
            },
          },
        },
      },
    },
  }) data: any,
): Promise<number> {
   ....
}

以获得这样的回送/资源管理器响应。

代码语言:javascript
复制
{
  "gameName": "string",
  "characters": [
    {
      "name": 0,
      "power": 0,
      "cost": 0,
      "ability": "string"
    }
  ]
}
票数 3
EN

Stack Overflow用户

发布于 2021-10-07 03:01:08

您不需要任何文档,而是有关描述请求的swagger文档:https://swagger.io/docs/specification/2-0/describing-request-body/?sbsearch=request

然后,只需在@requestBody装饰器中应用OpenAPI规范,就像黑暗未知中提到的那样。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/56920829

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档