首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >Swagger -正文中没有发送数据(swagger-jsdocs,swagger-ui-express)

Swagger -正文中没有发送数据(swagger-jsdocs,swagger-ui-express)
EN

Stack Overflow用户
提问于 2020-07-14 02:37:17
回答 1查看 1.5K关注 0票数 1

对于nodejs项目,我使用swagger-ui-express和swagger-jsdocs作为Swagger API。当我尝试使用Swagger调用应用程序的POST-Endpoint时,没有数据通过发送。可能的问题是什么?我的整个相关代码如下:

代码语言:javascript
复制
const swaggerOptionsJSDocs = {
swaggerDefinition: {
    openapi: '3.0.1', //tried with 3.0.0 as well
    info: {
        title: "Testproject",
        description: "Middleware for bla bla ",
        contact: {
            name: "John Doo"
        }
    }
},
apis: ["index.js"]
};




const swaggerDocs = swaggerJsDoc(swaggerOptionsJSDocs);

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocs));

**
 * @swagger
 * /user/upload:
 *  post:
 *      description: Receives a zipped and base64 encoded user
 *      consumes: 
 *         - application/json
 *      parameters:
 *          - in: body
 *            name: fullRequest // name here doesn't matter 
 *            description: ...
 *            schema:
 *              type: object
 *              required:
 *                  - user
 *              properties:
 *                  user:
 *                      type: string
 *                  jobId:
 *                      type: string
 *                  responseUrl:
 *                      type: string
 *                  inaugurationDate:
 *                      type: string
 *      responses:
 *          '201':
 *              description: user received and uploaded successfully
 *          '400':
 *              description: user data is missing or invalid
 *          '500':
 *              description: Internal server error
 *      
 *  
 *           
 */
app.post('/user/upload', function(req, res) {
  ....
}

Swagger正在执行get请求,但当它发送数据时,d-flag为空。有没有人有主意?

诚挚的问候

EN

回答 1

Stack Overflow用户

发布于 2020-11-17 13:15:23

参数'in:body‘无效。在Open API3中,您必须将requestBody作为单独的块传递。

此外,您必须使用@openapi才能使用Open API。

要查看requestBody对象的示例,请参阅here

代码语言:javascript
复制
**
 * @openapi
...
 *      requestBody:
 *            description: ...
 *            schema:
 *              type: object
 *              required:
 *                  - user
 *              properties:
 *                  user:
 *                      type: string
 *                  jobId:
 *                      type: string
 *                  responseUrl:
 *                      type: string
 *                  inaugurationDate:
 *                      type: string
....
票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/62882174

复制
相关文章

相似问题

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