Skip to content

hew-team1/all-api-dev

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

2021/06/27現在
OpenAPIを使用して仕様書を見れるようにyamlに書き換え中。 今後全てを移していく。 apidoc.yamlの内容をhttps://editor.swagger.ioにペーストすると確認できる。

2021/09/09
別途https://github.com/hew-team1/new-backendに改修中

api-dev

How to Use

環境を構築する

$make compose_build

環境を立ち上げる

$make compose_start

Dynamo-local Adminにアクセスする

localhost:8008

アクセス

EndUserAPI

POST [登録]

値へ

http://localhost:60001/users

GET [全件取得]

値へ

http://localhost:60001/users

GET [投稿中の取得]

値へ

http://localhost:60001/users/in-posts

GET [参加中の取得]

値へ

http://localhost:60001/users/in-join

RecruitAPI

POST [登録]

値へ

http://localhost:60002/recruits

GET [全件取得]

値へ

http://localhost:60002/recruits

GET [idのrecruit取得]

値へ

http://localhost:60002/recruits/{id}

PUT [idの募集の参加メンバーの追加]

値へ

http://localhost:60002/recruits/{id}/members

ConnpassAPI

GET [直近2ヶ月のハッカソンデータ取得]

値へ

http://localhost:60003/connpass

Admin EndUserAPI

GET [全件取得]

値へ

http://localhost:60011/users

PUT [isActiveの変更・アカウント停止の操作]

値へ

http://localhost:600011/users/active

Admin RecruitAPI

GET [全件取得]

値へ

http://localhost:60012/recruits

PUT [isActiveの変更・ボード停止の操作]

値へ

http://localhost:60012/recruits/active

APIの値

EndUserAPI

POST [登録]

// リクエスト
{
  "uid":   string, // 必須
  "name":  stirng, // 必須
  "email": string, // 必須
}

GET [全件取得]

// レスポンス
[
  {
    "uid":   string,
    "name":  string,
    "email": string,
  },
  {}, ...
]

GET [投稿中の取得]

// リクエスト [header]
key: uid
value: ユーザーID

// レスポンス
[
  {
    "id":          int,
    "masterId":    string,
    "title":       string,
    "eventDay":    string,
    "day":         string,   
    "organizer":   string,
    "commit":      string,
    "beginner":    stirng,
    "message":     string,
    "slackUrl":    string,
    "totalMember": string,   
    "position":    string,
    "reword":      string,
    "members": [
      {"uid": string, "position": string},
      {}, ...
    ],
    "created":  string,
    "updated":  string,
  },
  {}, ...
]

GET [参加中の取得]

// リクエスト [header]
key: uid
value: ユーザーID

// レスポンス
[
  {
    "id":          int,
    "masterId":    string,
    "title":       string,
    "eventDay":    string,
    "day":         string,   
    "organizer":   string,
    "commit":      string,
    "beginner":    stirng,
    "message":     string,
    "slackUrl":    string,
    "totalMember": string,   
    "position":    string,
    "reword":      string,
    "members": [
      {"uid": string, "position": string},
      {}, ...
    ],
    "created":  string,
    "updated":  string,
  },
  {}, ...
]

RecruitAPI

POST [登録]

// リクエスト
{
  "masterId":    string, // 必須
  "title":       string, // 必須
  "eventDay":    string, // 必須
  "day":         string, // 必須
  "organizer":   string, // 必須
  "commit":      string, // 必須
  "beginner":    stirng, // 必須
  "message":     string, // 必須
  "slackUrl":    string, // 必須
  "totalMember": string, // 必須
  "position":    string, // 必須
  "reword":      string, // 必須
}

GET [全件取得]

// レスポンス
[
  {
    "id":          int,
    "masterId":    string,
    "title":       string,
    "eventDay":    string,
    "day":         string,   
    "organizer":   string,
    "commit":      string,
    "beginner":    stirng,
    "message":     string,
    "slackUrl":    string,
    "totalMember": stirng,   
    "position":    string,
    "reword":      string,
    "members": [
      {"uid": string, "position": string},
      {}, ...
    ],
    "created": string,
    "updated": string,
  },
  {}, ...
]

GET [idのrecruit取得]

// レスポンス
{
  "id":          int,
  "masterId":    string,
  "title":       string,
  "eventDay":    string,
  "day":         string,
  "organizer":   string,
  "commit":      string,
  "beginner":    stirng,
  "message":     string,
  "slackUrl":    string,
  "totalMember": string,
  "position":    string,
  "reword":      string,
  "members": [
    {"uid": string, "position": string},
    {}, ...
  ],
  "created": string,
  "updated": string,
}

PUT [idの募集の参加メンバーの追加]

// リクエスト
{
  "uid":      int,    // 必須
  "position": string, // 必須
}

ConnpassAPI

GET [直近2ヶ月のハッカソンデータ取得]

// レスポンス
[
  {
    "event_id":   int,
    "event_url":  string,
    "title":      string,
    "started_at": string,
    "ended_at":   string,
  },
  {}, ...
]

Admin EndUserAPI

GET [全件取得]

// レスポンス
[
  {
    "uid":      string,
    "name":     string,
    "email":    string,
    "created":  string,
    "updated":  string,
    "isLogin":  bool,
    "isActive": bool,
  },
  {}, ...
]

PUT [isActiveの変更・アカウント停止の操作]

// リクエスト
{
  "uid":      string, // 必須
  "isActive": bool,   // 必須
}


Admin RecruitAPI

GET [全件取得]

// レスポンス
[
  {
    "id":          int,
    "masterId":    string,
    "title":       string,
    "eventDay":    string,
    "day":         string,   
    "organizer":   string,
    "commit":      string,
    "beginner":    stirng,
    "message":     string,
    "slackUrl":    string,
    "totalMember": string,   
    "position":    string,
    "members": [
      {"uid": string, "position": string},
      {}, ...
    ],
    "created":  string,
    "updated":  string,
    "isActive": bool,
  },
  {}, ...
]

PUT [isActiveの変更・ボード停止の操作]

// リクエスト
{
  "id":       int,  // 必須
  "isActive": bool, // 必須
}

About

HEWで作成した全てのAPIの集約場。制作終了後に作業しやすいように1つにまとめた

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors