На Swagger, как правильно написать файл yaml?

Question

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?

Answer 1

Как сказал Вантройс, dataType не является правильным ключом. Это тип. Но в этом случае вы пытаетесь определить метод post и вам нужно определить некоторые типы входных данных, как в примере ниже. Посмотрите на пример зоомагазина от самого чванства: 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"

Answer 2

Относительно ваших параметров: я думаю, что вы должны использовать «тип», а не «dataType»:

параметры: - имя: электронная почта

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

- имя: пароль

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