go-apix

command module
v0.0.0-...-f2de229 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 22, 2020 License: MIT Imports: 2 Imported by: 0

README

Golang API Starter

Golang v.1.14

Install:

git clone https://github.com/judascrow/go-apix.git
rm .git
rm go.mod
rm go.sum
go mod init <New Mudule>
git init
cp .env.example .env

Features

  • RESTful API
  • Gin
  • Gorm
  • Gin-Swagger
  • Log-Zap
  • Gin-Jwt
  • Casbin

COMMAND

Migrate & Seed :

go run main.go create seed

Run :

go run main.go

API ROUTER URI

Host: localhost:8000
Base Path: /api/v1
Healthcheck
Done Method URI authorize comment
GET /healthcheck No Check Status Service
Auth
Done Method URI authorize comment
POST /auth/login No Log in
Users
Done Method URI authorize comment
GET /users Yes List Users
GET /users/:slug Yes Get User by Slug
POST /users Yes Create User
PUT /users/:slug Yes Update User
DELETE /users/:slug Yes Delete User
PUT /users/:slug/password Yes Change Password
PUT /users/:slug/avatar Yes Upload Avatar
Swaggo
Generate command: swag init

URL: http://localhost:8000/api/v1/swagger/index.html
File Server

URL: http://localhost:8000/media

FOR DEV

GIT

Update

./git.sh "COMMENT"

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
api

Jump to

Keyboard shortcuts

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