Documentation
¶
Index ¶
- func CreateProject(c *gin.Context)
- func DeleteProject(c *gin.Context)
- func Login(c *gin.Context)
- func Logout(c *gin.Context)
- func PushMessage(c *gin.Context)
- func PushMulticast(c *gin.Context)
- func ReadAllProjects(c *gin.Context)
- func ReadProject(c *gin.Context)
- func Signup(c *gin.Context)
- func TopicSubscribe(c *gin.Context)
- func TopicUnsubscribe(c *gin.Context)
- func UpdateProject(c *gin.Context)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateProject ¶
CreateProject godoc @Summary 프로젝트 생성 @Description 프로젝트를 생성할 때 사용합니다. @Tags Project @Accept json @Produce json @Param Project body project.Project true "`Project` 예시" @Security BearerAuth @Success 201 {object} ent.Project @Failure 400 {object} response.errorResponse @Failure 401 {object} response.errorResponse @Failure 409 {object} response.errorResponse @Failure 500 {object} response.errorResponse @Router /api/project [post]
func DeleteProject ¶
DeleteProject godoc @Summary 단일 프로젝트 삭제 @Description 유저의 프로젝트 하나를 삭제할 때 사용합니다. @Tags Project @Accept json @Produce json @Param project_id path int true "Project ID" @Security BearerAuth @Success 204 @Failure 401 {object} response.errorResponse @Failure 404 {object} response.errorResponse @Failure 500 {object} response.errorResponse @Router /api/project/{project_id} [delete]
func Login ¶
Login godoc @Summary 로그인 @Description 유저가 로그인할 때 사용합니다. @Tags User @Accept json @Produce json @Param User body user.User true "User 예시" @Success 200 {object} response.AuthTokens @Failure 400 {object} response.errorResponse @Failure 401 {object} response.errorResponse @Failure 500 {object} response.AuthTokens @Router /api/user/login [post]
func Logout ¶
Logout godoc @Summary 로그아웃 @Description 유저가 로그아웃할 때 사용합니다. @Tags User @Produce json @Security BearerAuth @Success 204 @Failure 401 {object} response.errorResponse @Failure 500 {object} response.errorResponse @Router /api/user/logout [get]
func PushMessage ¶
PushMessage godoc @Summary 푸시 알림 전송 @Description 여러 개의 단일 메시지를 전송할 때 사용합니다. @Tags Firebase @Accept json @Produce json @Param X-Push-Client-Key header string true "프로젝트의 `Client-Key`" @Param Messages body firebase.Messages true "`Messages` 예시" @Security BearerAuth @Success 200 {object} response.FirebaseResponse @Failure 400 {object} response.errorResponse @Failure 401 {object} response.errorResponse @Failure 403 {object} response.errorResponse @Failure 500 {object} response.errorResponse @Router /api/push/message [post]
func PushMulticast ¶
PushMulticast godoc @Summary 푸시 알림 전송 @Description 하나의 메시지를 여러 기기에 전송할 때 사용합니다. @Tags Firebase @Accept json @Produce json @Param X-Push-Client-Key header string true "프로젝트의 `Client-Key`" @Param CustomMulticastMessage body firebase.CustomMulticastMessage true "`WithCustomMulticastMessage` 예시" @Security BearerAuth @Success 200 {object} response.FirebaseResponse @Failure 400 {object} response.errorResponse @Failure 401 {object} response.errorResponse @Failure 403 {object} response.errorResponse @Failure 500 {object} response.errorResponse @Router /api/push/multicast [post]
func ReadAllProjects ¶
ReadAllProjects godoc @Summary 모든 프로젝트 읽기 @Description 유저의 모든 프로젝트를 불러올 때 사용합니다. @Tags Project @Accept json @Produce json @Security BearerAuth @Success 200 {object} []ent.Project @Failure 401 {object} response.errorResponse @Failure 500 {object} response.errorResponse @Router /api/project/all [get]
func ReadProject ¶
ReadProject godoc @Summary 단일 프로젝트 읽기 @Description 유저의 프로젝트 하나를 불러올 때 사용합니다. @Tags Project @Accept json @Produce json @Param project_id path int true "Project ID" @Security BearerAuth @Success 200 {object} ent.Project @Failure 401 {object} response.errorResponse @Failure 404 {object} response.errorResponse @Failure 500 {object} response.errorResponse @Router /api/project/{project_id} [get]
func Signup ¶
Signup godoc @Summary 회원가입 @Description 새로운 유저가 가입할 때 사용합니다. @Tags User @Accept json @Produce json @Param User body user.User true "User 예시" @Success 201 {object} response.AuthTokens @Failure 400 {object} response.errorResponse @Failure 409 {object} response.errorResponse @Failure 500 {object} response.errorResponse @Router /api/user/signup [post]
func TopicSubscribe ¶
TopicSubscribe godoc @Summary 주제 구독 @Description 여러 기기를 주제에 구독시킬 때 사용합니다. @Tags Firebase @Accept json @Produce json @Param X-Push-Client-Key header string true "프로젝트의 `Client-Key`" @Param TopicWithTokens body firebase.TopicWithTokens true "`TopicWithTokens` 예시" @Security BearerAuth @Success 200 {object} response.FirebaseResponse @Failure 400 {object} response.errorResponse @Failure 401 {object} response.errorResponse @Failure 403 {object} response.errorResponse @Failure 500 {object} response.errorResponse @Router /api/topic/subscribe [post]
func TopicUnsubscribe ¶
TopicUnsubscribe godoc @Summary 주제 구독 해제 @Description 여러 기기를 구독 해제시킬 때 사용합니다. @Tags Firebase @Accept json @Produce json @Param X-Push-Client-Key header string true "프로젝트의 `Client-Key`" @Param TopicWithTokens body firebase.TopicWithTokens true "`TopicWithTokens` 예시" @Security BearerAuth @Success 200 {object} response.FirebaseResponse @Failure 400 {object} response.errorResponse @Failure 401 {object} response.errorResponse @Failure 403 {object} response.errorResponse @Failure 500 {object} response.errorResponse @Router /api/topic/unsubscribe [post]
func UpdateProject ¶
UpdateProject godoc @Summary 단일 프로젝트 수정 @Description 유저의 프로젝트 하나를 수정할 때 사용합니다. @Tags Project @Accept json @Produce json @Param project_id path int true "Project ID" @Param Project body project.Project true "`Project` 예시" @Security BearerAuth @Success 200 {object} ent.Project @Failure 401 {object} response.errorResponse @Failure 404 {object} response.errorResponse @Failure 500 {object} response.errorResponse @Router /api/project/{project_id} [put]
Types ¶
This section is empty.
Source Files