api

Documentation

Index

• Variables
• func GetCategoryPersistence(ctx context.Context) persistence.Persistencer[Category]
• func GetPostPersistence(ctx context.Context) persistence.Persistencer[Post]
• func HandleDeletePost(ctx context.Context, w http.ResponseWriter, r *http.Request) error
• func HandleMethodNotAllowed(ctx context.Context, r *http.Request)
• func HandleNotFound(w http.ResponseWriter, r *http.Request)
• func HandleRenderHome(w http.ResponseWriter, r *http.Request) error
• func HandleRenderPost(w http.ResponseWriter, r *http.Request) error
• func HandleSitemap(w http.ResponseWriter, ctx context.Context) error
• func InterceptorAccessLog(next box.H) box.H
• func NewApi(version, staticsDir string, postPersistencer persistence.Persistencer[Post], ...) http.Handler
• func PrettyError(next box.H) box.H
• type Category
  • func HandleCreateCategory(input *CreateCategoryRequest, w http.ResponseWriter, ctx context.Context) (*Category, error)
  • func (c *Category) Validate() error
• type CreateCategoryRequest
• type CreatePostRequest
• type HttpError
  • func (h HttpError) Error() string
• type ModifyPostRequest
• type Post
  • func HandleCreatePost(input *CreatePostRequest, w http.ResponseWriter, ctx context.Context) (*Post, error)
  • func HandleGetPost(ctx context.Context, r *http.Request) (*Post, error)
  • func HandleListPosts(w http.ResponseWriter, r *http.Request) ([]Post, error)
  • func HandleModifyPost(ctx context.Context, r *http.Request, input *ModifyPostRequest) (*Post, error)
  • func (e *Post) Validate() error

Variables

var ErrorPersistenceRead = HttpError{
	Status:      http.StatusInternalServerError,
	Description: "Problem reading from persistence layer",
}

var ErrorPersistenceWrite = HttpError{
	Status:      http.StatusInternalServerError,
	Description: "Problem writing to persistence layer",
}

var ErrorPostForbidden = HttpError{
	Status:      http.StatusForbidden,
	Description: "You are not authorized to perform this action for this post",
}

var ErrorPostNotFound = HttpError{
	Status:      http.StatusNotFound,
	Description: "Post not found",
}

Functions

func GetCategoryPersistence

func GetCategoryPersistence(ctx context.Context) persistence.Persistencer[Category]

GetCategoryPersistence from context (where categories are stored)

func GetPostPersistence

func GetPostPersistence(ctx context.Context) persistence.Persistencer[Post]

GetPostPersistence from context (where posts are stored)

func HandleDeletePost

func HandleDeletePost(ctx context.Context, w http.ResponseWriter, r *http.Request) error

func HandleMethodNotAllowed

func HandleMethodNotAllowed(ctx context.Context, r *http.Request)

func HandleNotFound

func HandleNotFound(w http.ResponseWriter, r *http.Request)

func HandleRenderHome

func HandleRenderHome(w http.ResponseWriter, r *http.Request) error

func HandleRenderPost

func HandleRenderPost(w http.ResponseWriter, r *http.Request) error

func HandleSitemap

func HandleSitemap(w http.ResponseWriter, ctx context.Context) error

func InterceptorAccessLog

func InterceptorAccessLog(next box.H) box.H

func NewApi

func NewApi(
	version, staticsDir string,
	postPersistencer persistence.Persistencer[Post],
	categoryPersistencer persistence.Persistencer[Category],
	log *slog.Logger,
) http.Handler

func PrettyError

func PrettyError(next box.H) box.H

Types

type Category

type Category struct {
	Id string `json:"id"`

	Name string `json:"name"`

	CreationTime     time.Time `json:"creation_time"`
	ModificationTime time.Time `json:"modification_time"`
}

func HandleCreateCategory

func HandleCreateCategory(input *CreateCategoryRequest, w http.ResponseWriter, ctx context.Context) (*Category, error)

func (*Category) Validate

func (c *Category) Validate() error

type CreateCategoryRequest

type CreateCategoryRequest struct {
	Name string `json:"name"`
}

type CreatePostRequest

type CreatePostRequest struct {
	Title string `json:"title"`
	Body  string `json:"body"`
}

type HttpError

type HttpError struct {
	Status      int    `json:"-"`
	Title       string `json:"title"`
	Description string `json:"description"`
}

func (HttpError) Error

func (h HttpError) Error() string

type ModifyPostRequest

type ModifyPostRequest struct {
	Title *string `json:"title"`
	Body  *string `json:"body"`
}

type Post

type Post struct {
	Id string `json:"id"`

	Author auth.User `json:"author"`

	Title string `json:"title"`
	Body  string `json:"body"`

	CreationTime     time.Time `json:"creation_time"`
	ModificationTime time.Time `json:"modification_time"`
}

func HandleCreatePost

func HandleCreatePost(input *CreatePostRequest, w http.ResponseWriter, ctx context.Context) (*Post, error)

func HandleGetPost

func HandleGetPost(ctx context.Context, r *http.Request) (*Post, error)

func HandleListPosts

func HandleListPosts(w http.ResponseWriter, r *http.Request) ([]Post, error)

func HandleModifyPost

func HandleModifyPost(ctx context.Context, r *http.Request, input *ModifyPostRequest) (*Post, error)

func (*Post) Validate

func (e *Post) Validate() error