You've already forked golang-saas-starter-kit
mirror of
https://github.com/raseels-repos/golang-saas-starter-kit.git
synced 2025-06-15 00:15:15 +02:00
Completed API documentation for swagger
This commit is contained in:
Lee Brown
@ -4,12 +4,14 @@ import (
|
||||
"context"
|
||||
"net/http"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/auth"
|
||||
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/platform/web"
|
||||
"geeks-accelerator/oss/saas-starter-kit/example-project/internal/project"
|
||||
"github.com/jmoiron/sqlx"
|
||||
"github.com/pkg/errors"
|
||||
"gopkg.in/go-playground/validator.v9"
|
||||
)
|
||||
|
||||
// Project represents the Project API method handler set.
|
||||
@ -19,7 +21,23 @@ type Project struct {
|
||||
// ADD OTHER STATE LIKE THE LOGGER IF NEEDED.
|
||||
}
|
||||
|
||||
// List returns all the existing projects in the system.
|
||||
// Find godoc
|
||||
// @Summary List projects
|
||||
// @Description Find returns the existing projects in the system.
|
||||
// @Tags project
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Security OAuth2Password
|
||||
// @Param where query string false "Filter string, example: name = 'Moon Launch'"
|
||||
// @Param order query string false "Order columns separated by comma, example: created_at desc"
|
||||
// @Param limit query integer false "Limit, example: 10"
|
||||
// @Param offset query integer false "Offset, example: 20"
|
||||
// @Param included-archived query boolean false "Included Archived, example: false"
|
||||
// @Success 200 {array} project.ProjectResponse
|
||||
// @Failure 400 {object} web.ErrorResponse
|
||||
// @Failure 403 {object} web.ErrorResponse
|
||||
// @Failure 500 {object} web.ErrorResponse
|
||||
// @Router /project [get]
|
||||
func (p *Project) Find(ctx context.Context, w http.ResponseWriter, r *http.Request, params map[string]string) error {
|
||||
claims, ok := ctx.Value(auth.Key).(auth.Claims)
|
||||
if !ok {
|
||||
@ -27,8 +45,57 @@ func (p *Project) Find(ctx context.Context, w http.ResponseWriter, r *http.Reque
|
||||
}
|
||||
|
||||
var req project.ProjectFindRequest
|
||||
if err := web.Decode(r, &req); err != nil {
|
||||
return errors.Wrap(err, "")
|
||||
|
||||
// Handle where query value if set.
|
||||
if v := r.URL.Query().Get("where"); v != "" {
|
||||
where, args, err := web.ExtractWhereArgs(v)
|
||||
if err != nil {
|
||||
return web.NewRequestError(err, http.StatusBadRequest)
|
||||
}
|
||||
req.Where = &where
|
||||
req.Args = args
|
||||
}
|
||||
|
||||
// Handle order query value if set.
|
||||
if v := r.URL.Query().Get("order"); v != "" {
|
||||
for _, o := range strings.Split(v, ",") {
|
||||
o = strings.TrimSpace(o)
|
||||
if o != "" {
|
||||
req.Order = append(req.Order, o)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Handle limit query value if set.
|
||||
if v := r.URL.Query().Get("limit"); v != "" {
|
||||
l, err := strconv.Atoi(v)
|
||||
if err != nil {
|
||||
err = errors.WithMessagef(err, "unable to parse %s as int for limit param", v)
|
||||
return web.NewRequestError(err, http.StatusBadRequest)
|
||||
}
|
||||
ul := uint(l)
|
||||
req.Limit = &ul
|
||||
}
|
||||
|
||||
// Handle offset query value if set.
|
||||
if v := r.URL.Query().Get("offset"); v != "" {
|
||||
l, err := strconv.Atoi(v)
|
||||
if err != nil {
|
||||
err = errors.WithMessagef(err, "unable to parse %s as int for offset param", v)
|
||||
return web.NewRequestError(err, http.StatusBadRequest)
|
||||
}
|
||||
ul := uint(l)
|
||||
req.Limit = &ul
|
||||
}
|
||||
|
||||
// Handle order query value if set.
|
||||
if v := r.URL.Query().Get("included-archived"); v != "" {
|
||||
b, err := strconv.ParseBool(v)
|
||||
if err != nil {
|
||||
err = errors.WithMessagef(err, "unable to parse %s as boolean for included-archived param", v)
|
||||
return web.NewRequestError(err, http.StatusBadRequest)
|
||||
}
|
||||
req.IncludedArchived = b
|
||||
}
|
||||
|
||||
res, err := project.Find(ctx, claims, p.MasterDB, req)
|
||||
@ -36,10 +103,28 @@ func (p *Project) Find(ctx context.Context, w http.ResponseWriter, r *http.Reque
|
||||
return err
|
||||
}
|
||||
|
||||
return web.RespondJson(ctx, w, res, http.StatusOK)
|
||||
var resp []*project.ProjectResponse
|
||||
for _, m := range res {
|
||||
resp = append(resp, m.Response(ctx))
|
||||
}
|
||||
|
||||
return web.RespondJson(ctx, w, resp, http.StatusOK)
|
||||
}
|
||||
|
||||
// Read returns the specified project from the system.
|
||||
// Read godoc
|
||||
// @Summary Get project by ID.
|
||||
// @Description Read returns the specified project from the system.
|
||||
// @Tags project
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Security OAuth2Password
|
||||
// @Param id path string true "Project ID"
|
||||
// @Success 200 {object} project.ProjectResponse
|
||||
// @Failure 400 {object} web.ErrorResponse
|
||||
// @Failure 403 {object} web.ErrorResponse
|
||||
// @Failure 404 {object} web.ErrorResponse
|
||||
// @Failure 500 {object} web.ErrorResponse
|
||||
// @Router /projects/{id} [get]
|
||||
func (p *Project) Read(ctx context.Context, w http.ResponseWriter, r *http.Request, params map[string]string) error {
|
||||
claims, ok := ctx.Value(auth.Key).(auth.Claims)
|
||||
if !ok {
|
||||
@ -69,10 +154,23 @@ func (p *Project) Read(ctx context.Context, w http.ResponseWriter, r *http.Reque
|
||||
}
|
||||
}
|
||||
|
||||
return web.RespondJson(ctx, w, res, http.StatusOK)
|
||||
return web.RespondJson(ctx, w, res.Response(ctx), http.StatusOK)
|
||||
}
|
||||
|
||||
// Create inserts a new project into the system.
|
||||
// Create godoc
|
||||
// @Summary Create new project.
|
||||
// @Description Create inserts a new project into the system.
|
||||
// @Tags project
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Security OAuth2Password
|
||||
// @Param data body project.ProjectCreateRequest true "Project details"
|
||||
// @Success 200 {object} project.ProjectResponse
|
||||
// @Failure 400 {object} web.ErrorResponse
|
||||
// @Failure 403 {object} web.ErrorResponse
|
||||
// @Failure 404 {object} web.ErrorResponse
|
||||
// @Failure 500 {object} web.ErrorResponse
|
||||
// @Router /projects [post]
|
||||
func (p *Project) Create(ctx context.Context, w http.ResponseWriter, r *http.Request, params map[string]string) error {
|
||||
v, ok := ctx.Value(web.KeyValues).(*web.Values)
|
||||
if !ok {
|
||||
@ -86,7 +184,13 @@ func (p *Project) Create(ctx context.Context, w http.ResponseWriter, r *http.Req
|
||||
|
||||
var req project.ProjectCreateRequest
|
||||
if err := web.Decode(r, &req); err != nil {
|
||||
return errors.Wrap(err, "")
|
||||
err = errors.WithStack(err)
|
||||
|
||||
_, ok := err.(validator.ValidationErrors)
|
||||
if ok {
|
||||
return web.NewRequestError(err, http.StatusBadRequest)
|
||||
}
|
||||
return err
|
||||
}
|
||||
|
||||
res, err := project.Create(ctx, claims, p.MasterDB, req, v.Now)
|
||||
@ -95,14 +199,31 @@ func (p *Project) Create(ctx context.Context, w http.ResponseWriter, r *http.Req
|
||||
case project.ErrForbidden:
|
||||
return web.NewRequestError(err, http.StatusForbidden)
|
||||
default:
|
||||
_, ok := err.(validator.ValidationErrors)
|
||||
if ok {
|
||||
return web.NewRequestError(err, http.StatusBadRequest)
|
||||
}
|
||||
return errors.Wrapf(err, "Project: %+v", &req)
|
||||
}
|
||||
}
|
||||
|
||||
return web.RespondJson(ctx, w, res, http.StatusCreated)
|
||||
return web.RespondJson(ctx, w, res.Response(ctx), http.StatusCreated)
|
||||
}
|
||||
|
||||
// Update updates the specified project in the system.
|
||||
// Read godoc
|
||||
// @Summary Update project by ID
|
||||
// @Description Update updates the specified project in the system.
|
||||
// @Tags project
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Security OAuth2Password
|
||||
// @Param data body project.ProjectUpdateRequest true "Update fields"
|
||||
// @Success 201
|
||||
// @Failure 400 {object} web.ErrorResponse
|
||||
// @Failure 403 {object} web.ErrorResponse
|
||||
// @Failure 404 {object} web.ErrorResponse
|
||||
// @Failure 500 {object} web.ErrorResponse
|
||||
// @Router /projects [patch]
|
||||
func (p *Project) Update(ctx context.Context, w http.ResponseWriter, r *http.Request, params map[string]string) error {
|
||||
v, ok := ctx.Value(web.KeyValues).(*web.Values)
|
||||
if !ok {
|
||||
@ -116,9 +237,14 @@ func (p *Project) Update(ctx context.Context, w http.ResponseWriter, r *http.Req
|
||||
|
||||
var req project.ProjectUpdateRequest
|
||||
if err := web.Decode(r, &req); err != nil {
|
||||
return errors.Wrap(err, "")
|
||||
err = errors.WithStack(err)
|
||||
|
||||
_, ok := err.(validator.ValidationErrors)
|
||||
if ok {
|
||||
return web.NewRequestError(err, http.StatusBadRequest)
|
||||
}
|
||||
return err
|
||||
}
|
||||
req.ID = params["id"]
|
||||
|
||||
err := project.Update(ctx, claims, p.MasterDB, req, v.Now)
|
||||
if err != nil {
|
||||
@ -130,14 +256,31 @@ func (p *Project) Update(ctx context.Context, w http.ResponseWriter, r *http.Req
|
||||
case project.ErrForbidden:
|
||||
return web.NewRequestError(err, http.StatusForbidden)
|
||||
default:
|
||||
return errors.Wrapf(err, "ID: %s Update: %+v", params["id"], req)
|
||||
_, ok := err.(validator.ValidationErrors)
|
||||
if ok {
|
||||
return web.NewRequestError(err, http.StatusBadRequest)
|
||||
}
|
||||
return errors.Wrapf(err, "ID: %s Update: %+v", req.ID, req)
|
||||
}
|
||||
}
|
||||
|
||||
return web.RespondJson(ctx, w, nil, http.StatusNoContent)
|
||||
}
|
||||
|
||||
// Archive soft-deletes the specified project from the system.
|
||||
// Read godoc
|
||||
// @Summary Archive project by ID
|
||||
// @Description Archive soft-deletes the specified project from the system.
|
||||
// @Tags project
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Security OAuth2Password
|
||||
// @Param data body project.ProjectArchiveRequest true "Update fields"
|
||||
// @Success 201
|
||||
// @Failure 400 {object} web.ErrorResponse
|
||||
// @Failure 403 {object} web.ErrorResponse
|
||||
// @Failure 404 {object} web.ErrorResponse
|
||||
// @Failure 500 {object} web.ErrorResponse
|
||||
// @Router /projects/archive [patch]
|
||||
func (p *Project) Archive(ctx context.Context, w http.ResponseWriter, r *http.Request, params map[string]string) error {
|
||||
v, ok := ctx.Value(web.KeyValues).(*web.Values)
|
||||
if !ok {
|
||||
@ -149,7 +292,18 @@ func (p *Project) Archive(ctx context.Context, w http.ResponseWriter, r *http.Re
|
||||
return errors.New("claims missing from context")
|
||||
}
|
||||
|
||||
err := project.Archive(ctx, claims, p.MasterDB, params["id"], v.Now)
|
||||
var req project.ProjectArchiveRequest
|
||||
if err := web.Decode(r, &req); err != nil {
|
||||
err = errors.WithStack(err)
|
||||
|
||||
_, ok := err.(validator.ValidationErrors)
|
||||
if ok {
|
||||
return web.NewRequestError(err, http.StatusBadRequest)
|
||||
}
|
||||
return err
|
||||
}
|
||||
|
||||
err := project.Archive(ctx, claims, p.MasterDB, req, v.Now)
|
||||
if err != nil {
|
||||
switch err {
|
||||
case project.ErrInvalidID:
|
||||
@ -159,14 +313,32 @@ func (p *Project) Archive(ctx context.Context, w http.ResponseWriter, r *http.Re
|
||||
case project.ErrForbidden:
|
||||
return web.NewRequestError(err, http.StatusForbidden)
|
||||
default:
|
||||
return errors.Wrapf(err, "Id: %s", params["id"])
|
||||
_, ok := err.(validator.ValidationErrors)
|
||||
if ok {
|
||||
return web.NewRequestError(err, http.StatusBadRequest)
|
||||
}
|
||||
|
||||
return errors.Wrapf(err, "Id: %s", req.ID)
|
||||
}
|
||||
}
|
||||
|
||||
return web.RespondJson(ctx, w, nil, http.StatusNoContent)
|
||||
}
|
||||
|
||||
// Delete removes the specified project from the system.
|
||||
// Delete godoc
|
||||
// @Summary Delete project by ID
|
||||
// @Description Delete removes the specified project from the system.
|
||||
// @Tags project
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Security OAuth2Password
|
||||
// @Param id path string true "Project ID"
|
||||
// @Success 201
|
||||
// @Failure 400 {object} web.ErrorResponse
|
||||
// @Failure 403 {object} web.ErrorResponse
|
||||
// @Failure 404 {object} web.ErrorResponse
|
||||
// @Failure 500 {object} web.ErrorResponse
|
||||
// @Router /projects/{id} [delete]
|
||||
func (p *Project) Delete(ctx context.Context, w http.ResponseWriter, r *http.Request, params map[string]string) error {
|
||||
claims, ok := ctx.Value(auth.Key).(auth.Claims)
|
||||
if !ok {
|
||||
|
||||
Reference in New Issue
Block a user