Skip to content

user.md

Latest commit

 

History

History
191 lines (145 loc) · 4.3 KB

user.md

File metadata and controls

191 lines (145 loc) · 4.3 KB
Raw
description api for Information of user

User

{% api-method method="get" host="https://api.todo-scheduler.com" path="/api/user" %} {% api-method-summary %} Get User Info {% endapi-method-summary %}

{% api-method-description %}

{% endapi-method-description %}

{% api-method-spec %} {% api-method-request %} {% api-method-headers %} {% api-method-parameter name="Authentication" type="string" required=true %}

{% endapi-method-parameter %} {% endapi-method-headers %} {% endapi-method-request %}

{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %}

{% endapi-method-response-example-description %}

{
  "email": "yeonzzu2@gmail.com",
  "nickname" : "Joylish",
  "info" : "Hello ~ I study now",
  "pictureUrl" : "https://s3.xxx.com" 
}

{% endapi-method-response-example %}

{% api-method-response-example httpCode=401 %} {% api-method-response-example-description %}

{% endapi-method-response-example-description %}

{    
    "message": "Unauthorized"
}

{% endapi-method-response-example %}

{% api-method-response-example httpCode=404 %} {% api-method-response-example-description %}

{% endapi-method-response-example-description %}

{    
    "message": "Not Found"
}

{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}

{% api-method method="post" host="https://api.todo-scheduler.com" path="/api/user/upload" %} {% api-method-summary %} Upload Picture {% endapi-method-summary %}

{% api-method-description %}

{% endapi-method-description %}

{% api-method-spec %} {% api-method-request %} {% api-method-headers %} {% api-method-parameter name="Authentication" type="string" required=true %}

{% endapi-method-parameter %} {% endapi-method-headers %}

{% api-method-body-parameters %} {% api-method-parameter name="picture" type="object" required=true %}

{% endapi-method-parameter %} {% endapi-method-body-parameters %} {% endapi-method-request %}

{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %}

{% endapi-method-response-example-description %}

{
  "email": "yeonzzu2@gmail.com",
  "nickname" : "Joylish",
  "info" : "Hello ~ I study now",
  "pictureUrl" : "https://s3.mmm.com" 
}

{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}

{% api-method method="patch" host="https://api.todo-scheduler.com" path="/api/user" %} {% api-method-summary %} Edit User Profile {% endapi-method-summary %}

{% api-method-description %}

{% endapi-method-description %}

{% api-method-spec %} {% api-method-request %} {% api-method-headers %} {% api-method-parameter name="Authentication" type="string" required=true %}

{% endapi-method-parameter %} {% endapi-method-headers %}

{% api-method-body-parameters %} {% api-method-parameter name="nickname" type="string" required=false %}

{% endapi-method-parameter %}

{% api-method-parameter name="info" type="string" required=false %}

{% endapi-method-parameter %} {% endapi-method-body-parameters %} {% endapi-method-request %}

{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %}

{% endapi-method-response-example-description %}

{
  "email": "yeonzzu2@gmail.com",
  "nickname" : "Joy",
  "info" : "Hello ~ I study now",
  "pictureUrl" : "https://s3.xxx.com" 
}

{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}

{% api-method method="delete" host="https://api.todo-scheduler.com" path="/api/user" %} {% api-method-summary %} Resign User {% endapi-method-summary %}

{% api-method-description %}

{% endapi-method-description %}

{% api-method-spec %} {% api-method-request %} {% api-method-headers %} {% api-method-parameter name="Authentication" type="string" required=true %}

{% endapi-method-parameter %} {% endapi-method-headers %} {% endapi-method-request %}

{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %}

{% endapi-method-response-example-description %}

{
    "message" : "success"
}

{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}