当前位置: 首页 > 知识库问答 >
问题:

在 Swagger 上,哪种是编写 yaml 文件的正确方法?[重复]

郭建华
2023-03-14
swagger: "2.0"
info: 
  version: "1.0.0"
  title: "CCA API"
host: localhost:1337
basePath: /v1
schemes: 
  - http
consumes:
  - application/json
produces:
  - application/json
paths:
  /user/login:
    post:
      description: Access a user account
      summary: User Account Access
      operationId: loginAccount
      parameters:
      - name: email
        dataType: string
        in: body
        required: true
        description: Your email
      - name: password
        dataType: string
        in: body
        required: true
        description: Your password
      responses:
        "200":
          description: Successfully signed in
          schema:
            type: object
            properties:
              email:
                type: string
              firstName:
                type: string
              lastName:
                type: string
              token:
                type: string
              userType:
                type: string
        401:
          description: Invalid email or password.

哪种是编写yaml文件的正确方法?我有这个错误:“不是有效的参数定义”在每个参数声明中......

还想知道Sails JS和Swagger融合的正确方法?

共有2个答案

薄高懿
2023-03-14

关于你的参数:我认为你必须使用“type”,而不是“dataType”:

参数:-名称:电子邮件

type: string
in: body
required: true
description: Your email

-名称:密码

type: string
in: body
required: true
description: Your password
曾喜
2023-03-14

正如Vantroys所说,dataType不是正确的键。它是类型。但是在这种情况下,您尝试定义一个post方法,并且需要定义某种类型的输入数据,如下例所示。看看swagger本身的宠物店示例:https://editor.swagger.io/

parameters:
  - in: "body"
    name: "body"
    description: "Pet object that needs to be added to the store"
    required: true
    schema:
      $ref: "#/definitions/Pet"
 类似资料:
  • 问题内容: 这个问题应该比关于更多。 我有一个子类(在python 2.7中,numpy 1.6.2),并且我发现在对象时未列出的字段名称(因此,ipython的自动完成功能无效)。 为了修复它,我尝试在子类中重写,如下所示: 结果是:。(我发现这里实际上应该在python 3.3中工作…) 作为一种解决方法,我尝试了: 据我所知,这是可行的,但当然并不优雅。 问题: 后一种解决方案对我而言是否正

  • 在OpenAPI/Swagger文件中声明“char”的正确方法是什么?我试过这些..但不起作用 我也很累,但运气不好

  • 我在写我的招摇文件时遇到了问题。当我描述一个参数时,这个参数的$ref的描述重载了这个描述(参见下面的示例)。 结果:描述过载 谁能帮我渡过难关吗?

  • 本文向大家介绍Node.js插件的正确编写方式,包括了Node.js插件的正确编写方式的使用技巧和注意事项,需要的朋友参考一下 Node.js在利用JavaScript编写后端方面效果拔群,值得我们多加尝试。不过如果大家需要一些无法直接使用的功能甚至是根本无从实现的模块使用,那么能否从C/C++库当中引入此类成果呢?答案是肯定的,大家要做的就是编写一款插件,并借此在自己的JavaScript代码中

  • 问题内容: 假设我要编写以下HQL查询: 将其编写为参数化查询的正确方法是什么,例如 问题答案: 我不确定如何使用位置参数来执行此操作,但是如果可以使用命名参数而不是位置参数,则可以将命名参数放在方括号内,并且可以使用Query接口中的setParameterList方法将值列表绑定到此参数。

  • null 现在的问题是: > 作为控制器方法执行的结果,我将返回对象的映射,该映射将解析为JSON。可能的实体是: {“结果”:“12”} 我应该如何提供基于结果的附加消息?我能想到两个解决办法: > 返回映射,该映射在肯定验证结果的情况下具有result=true,在否定验证结果的情况下具有result=false,以及带有相应消息的errorCode 返回指示验证结果的布尔值,并另外对否定结果