Documentation
¶
Overview ¶
Package cmd is a package to manage the application commands.
It documents and handle the server endpoints. Generate the swagger documentation
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateCourse ¶
func CreateCourse(c echo.Context) error
CreateCourse is a endpoint to create a course. @Summary Course creation @tags courses @description Create a course @accept json @produce json @param course body input.CreateCourse true "Course object which will be created" @success 201 {object} coursesHandler.HttpCourseCreated @failure 400 {object} coursesHandler.HttpCreateCourseBadRequestErr @failure 500 {object} httputil.HttpInternalServerErr @router /course [post]
func GetCourseByID ¶
func GetCourseByID(c echo.Context) error
GetCourseByID is a endpoint to get a course by ID. @summary Course retrieval @tags courses @description Get a course by ID @accept json @produce json @param courseID path string true "Course ID" @success 200 {object} coursesHandler.HttpCourseOk @failure 400 {object} coursesHandler.HttpCourseByIDBadRequestErr @failure 404 {object} coursesHandler.HttpCourseNotFoundErr @failure 500 {object} httputil.HttpInternalServerErr @router /course/:courseID [get]
func Ping ¶
func Ping(c echo.Context) error
Ping is a health check endpoint.
@summary Ping the server. @description A simple health check. @tags healthcheck @accept json @produce json @success 200 {object} httputil.PingOk @failure 500 {object} httputil.PingInternalServerErr @failure 502 {object} httputil.PingInternalServerErr @failure 503 {object} httputil.PingInternalServerErr @router /ping [get]
func RunServer ¶
func RunServer()
@title Effective Eureka API @version 0.0.1 @description This is a catalog video manager API. @contact.name Jean Molossi @contact.url https://jeanmolossi.com.br/ @contact.email jean.carlosmolossi@gmail.com @license.name Apache 2.0 @license.url http://www.apache.org/licenses/LICENSE-2.0.html @host localhost:8080 @BasePath / @securityDefinitions.basic BasicAuth
Types ¶
This section is empty.
Source Files
Directories