Giter VIP home page Giter VIP logo

apimanager's Introduction

项目介绍

什么是接口文档管理工具?

采用golang 基于Gin框架编写的在线API文档管理系统;其致力于快速解决团队内部接口文档的编写、维护、存档,以及减少团队协作开发的沟通成本。

特点

  • 轻量级
  • 架构简单轻巧利于二次开发
  • 部署维护方便

安装方法

方法一 编译安装

  • 在MySQL中创建mysql数据库,db.sql导入
  • 修改 /config/config.ini 配置文件,修改数据库连接信息
  • go get github.com/gongwalker/ApiManager
  • go mod vendor
  • go build
  • 运行 ./run.sh start|stop
  • 浏览器打开 http://your_host:8000 (账号密码 root 123456)

方法二 直接使用

Linux环境

Windows环境

Mac环境

使用说明

  1. 系统有三个角色,超级管理、管理员、游客

    • 超级管理员 拥用一切权限(api分类管理,api管理)
    • 管理 可创建编辑API
    • 游客 只能查看接口分类和接口信息 无增删改权限
  2. 默认的超级管理员 账号root 密码:123456

用到了哪些技术及项目价值

  1. 前端页面采用 layui-v2.5.6,Bootstrap v3.3.4,后端采用gin框架编写Restful Api 接口,前后端分离。
  2. 后端用到了表单校验,权限校验中间件定义,mysql数据存档,项目session可以支持cookie与redis两个储存方案
  3. 适用于中小团队api文档管理使用
  4. 可以作为一个基础角手架进行使用,快速开发。初学者可以作为熟悉gin框架学习所用

系统长什么样

image

image

image

image

image

作者信息

最后

非常欢迎大家贡献代码,让这个项目成长的更好。

apimanager's People

Contributors

tianmingxing avatar gongwalker avatar gongcoder avatar leeka515 avatar huangjian80s 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.