resource

package

v0.0.0-...-95b4fb8 Latest Latest Go to latest Published: Mar 25, 2022 License: MIT Imports: 7 Imported by: 16

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/manyminds/api2go

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ChocolateResource ¶

type ChocolateResource struct {
	ChocStorage *storage.ChocolateStorage
	UserStorage *storage.UserStorage
}

ChocolateResource for api2go routes

func (ChocolateResource) Create ¶

func (c ChocolateResource) Create(obj interface{}, r api2go.Request) (api2go.Responder, error)

Create a new choc

func (ChocolateResource) Delete ¶

func (c ChocolateResource) Delete(id string, r api2go.Request) (api2go.Responder, error)

Delete a choc :(

func (ChocolateResource) FindAll ¶

func (c ChocolateResource) FindAll(r api2go.Request) (api2go.Responder, error)

FindAll chocolates

func (ChocolateResource) FindOne ¶

func (c ChocolateResource) FindOne(ID string, r api2go.Request) (api2go.Responder, error)

FindOne choc

func (ChocolateResource) Update ¶

func (c ChocolateResource) Update(obj interface{}, r api2go.Request) (api2go.Responder, error)

Update a choc

type Response ¶

type Response struct {
	Res  interface{}
	Code int
}

The Response struct implements api2go.Responder

func (Response) Metadata ¶

func (r Response) Metadata() map[string]interface{}

Metadata returns additional meta data

func (Response) Result ¶

func (r Response) Result() interface{}

Result returns the actual payload

func (Response) StatusCode ¶

func (r Response) StatusCode() int

StatusCode sets the return status code

type UserResource ¶

type UserResource struct {
	ChocStorage *storage.ChocolateStorage
	UserStorage *storage.UserStorage
}

UserResource for api2go routes

func (UserResource) Create ¶

func (s UserResource) Create(obj interface{}, r api2go.Request) (api2go.Responder, error)

Create method to satisfy `api2go.DataSource` interface

func (UserResource) Delete ¶

func (s UserResource) Delete(id string, r api2go.Request) (api2go.Responder, error)

Delete to satisfy `api2go.DataSource` interface

func (UserResource) FindAll ¶

func (s UserResource) FindAll(r api2go.Request) (api2go.Responder, error)

FindAll to satisfy api2go data source interface

func (UserResource) FindOne ¶

func (s UserResource) FindOne(ID string, r api2go.Request) (api2go.Responder, error)

FindOne to satisfy `api2go.DataSource` interface this method should return the user with the given ID, otherwise an error

func (UserResource) PaginatedFindAll ¶

func (s UserResource) PaginatedFindAll(r api2go.Request) (uint, api2go.Responder, error)

PaginatedFindAll can be used to load users in chunks

func (UserResource) Update ¶

func (s UserResource) Update(obj interface{}, r api2go.Request) (api2go.Responder, error)

Update stores all changes on the user

Source Files ¶

View all Source files

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