api.yml

resourcePath: /users
description: All about API
produces:
- application/json

apis:
- path: /api/users
  operations:

  - httpMethod: GET
    summary: Get the list of all Users
    responseClass: User
    nickname: getAllUsers

  - httpMethod: POST
    summary: Add a new user User
    responseClass: User
    nickname: createUser
    parameters:
        - name: body
          dataType: User
          paramType: body
          required: true
          description: Ton object User
    responseMessages:
        - code: 400
          message: Invalid User parameters

- path: /api/users/{id}
  operations:
  - httpMethod: GET
    summary: Get an existing user by his ID
    responseClass: User
    nickname: getUserById
    parameters:
        - name: id
          dataType: Integer
          paramType: path
          required: true
    responseMessages:
        - code: 404
          message: User not found

  - httpMethod: PUT
    summary: Update an existing user by his id
    responseClass: User
    nickname: updateUserById
    parameters:
        - name: id
          dataType: Integer
          paramType: path
          required: true
        - name: body
          dataType: User
          paramType: body
          required: true
          description: Your User
    responseMessages:
        - code: 404
          message: User not found
        - code: 400
          message: Invalid User parameters

  - httpMethod: Delete
    summary: Delete a user by his Id
    responseClass: User
    nickname: deleteUserById
    parameters:
        - name: id
          dataType: Integer
          paramType: path
          required: true

models:
    User:
      id: User
      properties:
        nom:
          type: String
          required: true
        prenom:
          type: String
          required: true
        email:
          type: String
          required: true
        telephone:
          type: String
          required: true