README
¶
Model templates with gorp orm for gin
Description
Data model templates with gorp orm for gin
Usage
Create a "models" directory in your project
cp gin-model-template/*.go myproject/models/
agent.go and user.go are tables templates. Feel free to rename files and fix XXX tags.
Test with go test
repo.go contains database parameters.
In your main.go project import ./models
Sample :
package main
import (
"fmt"
"github.com/gin-gonic/gin"
. "./models"
)
func main() {
r := gin.Default()
r.Use(Database("test.sqlite3"))
v1 := r.Group("api/v1")
{
v1.GET("/users", GetUsers)
v1.GET("/users/:id", GetUser)
v1.POST("/users", PostUser)
v1.PUT("/users/:id", UpdateUser)
v1.DELETE("/users/:id", DeleteUser)
v1.OPTIONS("/users", Options) // POST
v1.OPTIONS("/users/:id", Options) // PUT, DELETE
...
## TODO
Sample
Licence
MIT License
Copyright (c) 2016 Yves Agostini
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Documentation
¶
Index ¶
- func Database(connString string) gin.HandlerFunc
- func DeleteAgent(c *gin.Context)
- func DeleteUser(c *gin.Context)
- func GetAgent(c *gin.Context)
- func GetAgents(c *gin.Context)
- func GetUser(c *gin.Context)
- func GetUsers(c *gin.Context)
- func InitDb(dbName string) *gorp.DbMap
- func ParseQuery(q map[string][]string) string
- func PostAgent(c *gin.Context)
- func PostUser(c *gin.Context)
- func UpdateAgent(c *gin.Context)
- func UpdateUser(c *gin.Context)
- type Agent
- type User
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Database ¶
func Database(connString string) gin.HandlerFunc
Database gin Middlware to select database
func ParseQuery ¶
ParseQuery parse query to set select SQL query
Types ¶
type Agent ¶
type Agent struct {
Id int64 `db:"id" json:"id"`
Name string `db:"name" json:"name"`
IP string `db:"ip" json:"ip"`
FileSurvey string `db:"filesurvey" json:"filesurvey"`
Role string `db:"role" json:"role"`
Status string `db:"status" json:"status"`
Created time.Time `db:"created" json:"created"` // or int64
Updated time.Time `db:"updated" json:"updated"`
}
XXX custom struct name and fields Agent db and json type
type User ¶
type User struct {
Id int64 `db:"id" json:"id"`
Name string `db:"name" json:"name"`
Email string `db:"email" json:"mail"`
Status string `db:"status" json:"status"`
Comment string `db:"comment, size:16384" json:"comment"`
Pass string `db:"pass" json:"pass"`
Created time.Time `db:"created" json:"created"` // or int64
Updated time.Time `db:"updated" json:"updated"`
}
XXX custom struct name and fields User db and json type
Source Files