swagger

package

v0.0.0-...-1037a2b Latest Latest Go to latest Published: Jul 31, 2021 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/JayanSmart/smight-tasks

README ¶

Go API Server for swagger

A go-lang API to manage chores (repeating) and todo items (once-off) for my household.

Overview

This server was generated by the [swagger-codegen] (https://github.com/swagger-api/swagger-codegen) project.
By using the OpenAPI-Spec from a remote server, you can easily generate a server stub.

To see how to make this your own, look here:

README

API version: 0.0.1
Build date: 2021-07-31T20:28:41.047Z[GMT]

Running the server

To run the server, follow these simple steps:

go run main.go

Documentation ¶

Overview ¶

* SmightTasksAPI * * A go-lang API to manage chores (repeating) and todo items (once-off) for my household. * * API version: 0.0.1 * Contact: jayandrinsmart@gmail.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

func AddTask(w http.ResponseWriter, r *http.Request)
func CreateUser(w http.ResponseWriter, r *http.Request)
func DeleteTask(w http.ResponseWriter, r *http.Request)
func DeleteUser(w http.ResponseWriter, r *http.Request)
func FindTasksByStatus(w http.ResponseWriter, r *http.Request)
func FindTasksByUser(w http.ResponseWriter, r *http.Request)
func GetTaskById(w http.ResponseWriter, r *http.Request)
func GetTasks(w http.ResponseWriter, r *http.Request)
func GetUserByName(w http.ResponseWriter, r *http.Request)
func Index(w http.ResponseWriter, r *http.Request)
func Logger(inner http.Handler, name string) http.Handler
func NewRouter() *mux.Router
func UpdateTask(w http.ResponseWriter, r *http.Request)
func UpdateTaskWithForm(w http.ResponseWriter, r *http.Request)
func UpdateUser(w http.ResponseWriter, r *http.Request)
type ApiResponse
type Route
type Routes
type Task
type User

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AddTask ¶

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

func CreateUser ¶

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

func DeleteTask ¶

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

func DeleteUser ¶

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

func FindTasksByStatus ¶

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

func FindTasksByUser ¶

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

func GetTaskById ¶

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

func GetTasks ¶

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

func GetUserByName ¶

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

func Index ¶

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

func Logger ¶

func Logger(inner http.Handler, name string) http.Handler

func NewRouter ¶

func NewRouter() *mux.Router

func UpdateTask ¶

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

func UpdateTaskWithForm ¶

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

func UpdateUser ¶

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

Types ¶

type ApiResponse ¶

type ApiResponse struct {
	Code int32 `json:"code,omitempty"`

	Type_ string `json:"type,omitempty"`

	Message string `json:"message,omitempty"`
}

type Route ¶

type Route struct {
	Name        string
	Method      string
	Pattern     string
	HandlerFunc http.HandlerFunc
}

type Routes ¶

type Routes []Route

type Task ¶

type Task struct {
	Id int64 `json:"id,omitempty"`

	Title string `json:"title"`
	// True for tasks which are ongoing/repeating
	Repeating bool `json:"repeating"`

	Users []User `json:"users,omitempty"`
	// current status of the task
	Status string `json:"status,omitempty"`
}

type User ¶

type User struct {
	Id int64 `json:"id,omitempty"`

	Username string `json:"username,omitempty"`

	FirstName string `json:"firstName,omitempty"`

	LastName string `json:"lastName,omitempty"`

	Email string `json:"email,omitempty"`

	Password string `json:"password,omitempty"`

	Phone string `json:"phone,omitempty"`
	// User Status
	UserStatus int32 `json:"userStatus,omitempty"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL