GithubHelp home page GithubHelp logo

irisapiproject's Introduction

IrisApi

国内下载太慢的同学移步码云 IrisApiProject

项目介绍

  • 采用 iris 框架目后台api IrisApiProject
  • 采用了 gorm 数据库模块 和 jwt 的单点登陆认证方式
  • 测试默认使用了 sqlite3 数据库

项目目录结构

  • apidoc 接口文档目录
  • caches redis缓存目录
  • config 项目配置文件目录
  • controllers 控制器文件目录
  • database 数据库文件目录
  • middleware 中间件文件目录
  • models 模型文件目录
  • routes 路由文件
  • resources 前端文件
  • tmp 测试数据库 sqlite3 文件目录
  • tools 其他公用方法目录

api项目初始化

拉取项目

git clone https://github.com/snowlyg/IrisApiProject.git

加载依赖管理包

使用 gopm 管理包


go get -v -u github.com/gpmgo/gopm

# 查看当前工程依赖
gopm list
# 显示依赖详细信息
gopm list -v
# 列出文件依赖
gopm list -t [file]
# 拉取依赖到缓存目录
gopm get -r xxx
# 仅下载当前指定的包
gopm get -d xxx
# 拉取依赖到$GOPATH
gopm get -g xxx
# 检查更新所有包
gopm get -u xxx
# 拉取到当前所在目录
gopm get -l xxx
# 运行当前目录程序
gopm run
# 生成当前工程的 gopmfile 文件用于包管理
gopm gen -v
# 根据当前项目 gopmfile 链接依赖并执行 go install
gopm install -v
# 更新当前依赖
gopm update -v
# 清理临时文件
gopm clean
# 编译到当前目录
gopm bin

项目配置文件 /config/config.toml

cp config.toml.example config.toml

运行项目

gowatch

go get github.com/silenceper/gowatch

gowatch //安装 gowatch 后才可以使用这个命令,不然只能使用

go run main.go // go 命令

单元测试

http test

 go test -v  //所有测试
 
 go test -run TestUserCreate -v //单个测试
 

api 文档使用

自动生成文档 (访问过接口就会自动成功) 因为原生的 jquery.min.js 里面的 cdn 是使用国外的,访问很慢。 有条件的可以开个 vpn ,如果没有可以根据下面的方法修改一下,访问就很快了

打开 /resource/apiDoc/index.html 修改里面的

https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js

国内的 cdn


https://cdn.bootcss.com/jquery/2.1.3/jquery.min.js

访问文档,从浏览器直接打开 http://localhost/apiDoc


登录项目

输入地址 http://localhost:80

//在 conig/config.toml 内配置 LoginUserNameLoginPwd

项目管理员账号 : username 项目管理员密码 : password

问题总结

问题总结

参考资料

irisapiproject's People

Contributors

snowlyg avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.