API docs

Welcome to the Osori-HackDay wiki!

Login

• method: FORM-POST

• path: /login

• send parameter

  "name": (string)
  

• response

-> redirection

Repository 현황

• method: GET

• path: /repo

• response

  [(Repository0), (Repository1), ...]
  

    // Repository
  
        ```javascript
        {
            "name": (string), // repository name
            "link": (string),  // repository link
            "repo_size": (number), // repository size (unit KB)
            "star": (number),  // repository star count
            "commit": (number),
            "users": [(Contributor0), (Contributor1), ...],
                    // repository contributors .. - contributor 객체는 밑에 정의 됨
        }
        ```
  
    // Contributor
  
        ```javascript
        {
            "name": (string),  // contributor name
            "commit": (number),  // contributor commit count on this repository
            "link": (string),  // contributor profile link
        }
        ```
  

Awesome

현재 best contributor 와 best commit repository 를 보여준다

• method: GET

• path: /awesome

• response

  {
      "best_commit_contributor": (Contributor)
      "best_commit_repo": (Repository)
  }
  

Home websocket

• method: websocket

• path: /conn

• send to server

  send chat

  {
      "name": (string),
      "message": (string),
      "type": "message"
  }
  

• receive from server

  receive chat

  {
      "name": (string),
      "message": (string),
      "type": "message"
  }
  

  receive notice

  {
      "title": (string),
      "message": (string),
      "type": "notice"
  }