api

Documentation

Index

• type GeneralResponse
• type JobController
  • func NewJobController(jobRepo repo.JobRepository, jobParticipantRepo repo.JobParticipantRepository, ...) *JobController
  • func (controller *JobController) Route(r *gin.RouterGroup)
• type ProjectController
  • func NewProjectController(projectRepo repo.ProjectRepository, siteRepo repo.SiteRepository, ...) *ProjectController
  • func (controller *ProjectController) Route(r *gin.RouterGroup)
• type SiteController
  • func NewSiteController(repo repo.SiteRepository) *SiteController
  • func (controller *SiteController) Route(r *gin.RouterGroup)

Types

type GeneralResponse

type GeneralResponse struct {
	Code    int         `json:"code" example:"0"`
	Message string      `json:"message" example:"success"`
	Data    interface{} `json:"data" swaggertype:"object"`
}

GeneralResponse is used for typical API response

type JobController

type JobController struct {
	// contains filtered or unexported fields
}

JobController handles job related APIs

func NewJobController

func NewJobController(jobRepo repo.JobRepository,
	jobParticipantRepo repo.JobParticipantRepository,
	projectRepo repo.ProjectRepository,
	siteRepo repo.SiteRepository,
	projectDataRepo repo.ProjectDataRepository,
) *JobController

NewJobController returns a controller instance to handle job API requests

func (*JobController) Route

func (controller *JobController) Route(r *gin.RouterGroup)

Route set up route mappings to job related APIs

type ProjectController

type ProjectController struct {
	// contains filtered or unexported fields
}

ProjectController handles project related APIs

func NewProjectController

func NewProjectController(projectRepo repo.ProjectRepository, siteRepo repo.SiteRepository,
	participantRepo repo.ProjectParticipantRepository,
	invitationRepo repo.ProjectInvitationRepository,
	projectDataRepo repo.ProjectDataRepository) *ProjectController

NewProjectController returns a controller instance to handle project API requests

func (*ProjectController) Route

func (controller *ProjectController) Route(r *gin.RouterGroup)

Route set up route mappings to project related APIs

type SiteController

type SiteController struct {
	// contains filtered or unexported fields
}

SiteController provides API handlers for the site related APIs

func NewSiteController

func NewSiteController(repo repo.SiteRepository) *SiteController

NewSiteController returns a controller instance to handle site API requests

func (*SiteController) Route

func (controller *SiteController) Route(r *gin.RouterGroup)

Route set up route mappings to site related APIs