v1.0.0

click33 · Apr 23, 2020 · 3c28724 · 3c28724
1 parent 82bb365
commit 3c28724
Show file tree

Hide file tree

Showing 14 changed files with 979 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
diff --git a/.nojekyll b/.nojekyll
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -1 +1,47 @@
-sa-doc
+# 介绍
+
+------
+
+## sa-doc是什么？
+一个基于markdown的接口文档编写工具
+- 基础框架基于：[docsify](https://docsify.js.org/) 
+- 书写格式参考：[apidoc](https://apidocjs.com/) 
+- 根据markdown格式编写api接口文档，写时方便
+- 自动将markdown格式转换为表格形式，看时方便
+
+
+## 获取最新代码
+- 你可以从gitee，或者github上获取最新代码 
+- gitee地址：[https://gitee.com/sz6/sa-doc](https://gitee.com/sz6/sa-doc)
+- github地址：[https://github.com/click33/sa-doc](https://github.com/click33/sa-doc)
+
+
+## sa系列其他工具
+
+- **sa-token：**[一个的JavaWeb权限认证框架，强大、简单、好用](http://sa-token.dev33.cn/)
+- **sa-admin：**[一个多窗口后台模板，流畅、易上手、提高生产力](http://sa-admin.dev33.cn/)
+- **sa-fast：**[一个基于springboot架构的快速开发平台，内置代码生成器](http://sa-fast.dev33.cn/)
+- **sa-vue-admin：**[对sa-admin的vue单页版实现, 基于vue-cli、element-ui的单页后台模板](http://sa-vue-admin.dev33.cn/)
+- **SqlFly：**[一个好用的ORM框架](https://sqlfly.dev33.cn/)
+
+## 贡献代码
+1. 在github上fork一份到自己的仓库
+2. clone自己的仓库到本地电脑
+3. 在本地电脑修改、commit、push
+4. 提交pr（点击：New Pull Request）（提交pr前请保证自己fork的仓库是最新版本，如若不是先强制更新一下）
+5. 等待合并
+
+## 建议贡献的地方
+- 修复源码现有bug，或增加新的实用功能
+- 完善在线文档，或者修复现有错误之处
+- 如果更新实用功能，可在文档友情链接处留下自己的推广链接
+
+## 交流群
+QQ交流群：[782974737 点击加入](https://jq.qq.com/?_wv=1027&k=5DHN5Ib)
+
+![扫码加群](https://color-test.oss-cn-qingdao.aliyuncs.com/sqlfly-doc/qqq.png ':size=150')
+
+
+
+
+
diff --git a/_coverpage.md b/_coverpage.md
@@ -0,0 +1,16 @@
+<!-- 这是封面文件 -->
+
+<!-- ![logo](logo.png) -->
+# <span style="font-size: 60px;">sa-doc 接口文档</span> <small>v1.0.0</small>
+
+<!-- > 一个好用的接口文档编写工具 -->
+
+- 根据markdown格式编写api接口文档，写时方便
+- 自动将markdown格式转换为表格形式，看时方便
+
+<br>
+
+[GitHub](https://github.com/click33/sa-doc)
+[码云](https://gitee.com/sz6/sa-doc)
+[查看文档](#介绍)
+
diff --git a/_sidebar.md b/_sidebar.md
@@ -0,0 +1,13 @@
+<!-- 这是目录树文件 -->
+
+- **开始**
+	- [介绍](/README)
+	- [文档说明](/sa-lib/doc-exp)
+
+- **文档**
+	- [用户相关](/project/user)
+	- [首页轮播图](/project/swiper) 
+	- [各种示例](/project/p-case) 
+
+
+
diff --git a/index.html b/index.html
@@ -0,0 +1,52 @@
+<!DOCTYPE html>
+<html lang="en">
+	<head>
+		<title>sa-doc接口文档</title>
+		<meta charset="UTF-8">
+		<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+		<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+		<link rel="shortcut icon" type="image/x-icon" href="sa-lib/logo.png">
+		<link rel="stylesheet" href="https://unpkg.com/docsify@4.11.3/lib/themes/vue.css">
+		<link rel="stylesheet" href="./sa-lib/index.css">
+		<script src="./sa-lib/index.js"></script> 
+	</head>
+	<body>
+		<nav>
+			<a href="./index.html">首页</a>
+			<a href="./index.html#/sa-lib/doc-exp">接口说明</a>
+			<a href="https://jq.qq.com/?_wv=1027&k=5DHN5Ib" target="_blank">QQ群</a>
+		</nav>
+		<div class="main-box">
+			<div id="app">加载中...</div>
+		</div>
+		<script>
+			var name = '<img style="width: 50px; height: 50px; vertical-align: middle;" src="sa-lib/logo.png" alt="logo" /> ';
+			name += '<b style="font-size: 24px; vertical-align: middle;">sa-doc 接口文档</b>'
+			// 一些配置 
+			window.$docsify = {
+				name: name, // 名字 
+				basePath: '/sa-doc/', // 项目名，如果部署时带路径上下文，则必须写这个   
+				// themeColor: '#06A3D7', // 主题颜色  
+				repo: 'https://github.com/click33/sa-doc', // github地址 
+				auto2top: true, // 是否在切换页面后回到顶部 
+				// coverpage: true, // 开启封面 
+				subMaxLevel: 3, // 标题解析层级, 写几就在目录树中解析到几级标题 ,一般写2吧也就 
+				loadSidebar: true, // 加载自定义侧边栏 , 目录定制在: _sidebar.md 文件 (需要创建 .nojekyll 的空文件，阻止 GitHub Pages 忽略命名是下划线开头的文件)  
+				copyCode: { // 复制插件 
+					buttonText: '复制到剪贴板',
+					errorText: '错误',
+					successText: '复制成功'
+				},
+				alias: {
+					'/.*/_sidebar.md': '/_sidebar.md'
+				},
+				search: 'auto', // 打开搜索功能 
+				plugins: [sa_plugins]	// 自定义插件 
+			}
+		</script>
+		<script src="https://unpkg.com/docsify@4.9.4/lib/docsify.min.js"></script>
+		<script src="https://unpkg.com/docsify-copy-code@2.1.0/dist/docsify-copy-code.min.js"></script>
+		<script src="https://unpkg.com/prismjs@1.20.0/components/prism-java.js"></script>
+		<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
+	</body>
+</html>
diff --git a/project/p-case.md b/project/p-case.md
@@ -0,0 +1,43 @@
+# 参数示例
+
+演示 `sa-doc` 的各种写法，具体可根据源码对比最终展现结果 
+
+---
+
+- 写一个接口
+``` api
+	/SysSwiper/add
+```
+- 参数 - 最简单写法
+``` p
+	username			账号名称 
+	password			账号密码 
+	way					登录方式(1=账号登录，2=id登录，3=手机号登录)
+```
+
+- 参数 - 带默认值 
+``` p
+	username = admin			账号名称 
+	password = admin			账号密码 
+	way = 1						登录方式 (1=账号登录，2=id登录，3=手机号登录)
+```
+
+- 参数 - 带数据类型 
+``` p
+	{String}	username = admin			账号名称 
+	{String}	password = admin			账号密码 
+	{String}	way = 1						登录方式 (1=账号登录，2=id登录，3=手机号登录)
+```
+
+- 返回示例
+``` js
+	{
+		"code": 200,        // 状态码
+		"msg": "ok"            // 返回描述
+		"data": null        // 携带数据：一般在查询时有值
+		"dataCount": null        // 数据总数：一般在分页查询时有值
+	}
+```
+
+- 导入一段代码
+@import(res)
diff --git a/project/swiper.md b/project/swiper.md
@@ -0,0 +1,114 @@
+# 轮播图相关 
+
+---
+
+### 1、增加
+- 接口
+``` api
+	/SysSwiper/add
+```
+- 参数
+``` p
+	{String}	title=""			标题 
+	{String}	img_src=""			图片地址 
+	{String}	link=""				链接 
+	{int}		status=1			状态（1=正常，2=禁用） 
+	{long}		sort=1				排序值 
+```
+- 返回 
+@import(res)
+
+
+### 2、删除
+- 接口
+``` api
+	/SysSwiper/delete
+```
+- 参数
+``` p
+	id			要删除的记录id
+```
+- 返回
+@import(res)
+
+
+### 3、修改
+- 接口
+``` api
+	/SysSwiper/delete
+```
+- 参数
+``` p
+	{String}	title=""		标题
+	{String}	img_src=""		图片地址
+	{String}	link=""			链接
+	{int}		status=1		状态（1=正常，2=禁用）
+	{long}		sort=0			排序值
+	{long}		id=""			要修改的记录id
+```
+- 返回
+@import(res)
+
+
+### 4、查 - 根据id
+- 接口
+```  api 
+	/SysSwiper/getById
+```
+- 参数
+``` p
+	id				要查询的记录id
+```
+- 返回示例
+``` js
+	{
+		"code": 200,
+		"msg": "ok",
+		"data": {
+			"id": 2,		// 记录id
+			"title": "第2个  ",		// 标题
+			"img_src": "https://xxx.com/1.png",		// 图片地址
+			"type": 1,	// 类型，暂无作用，留作以后扩展
+			"link": "",	// 链接
+			"click_count": 0,	// 点击次数
+			"create_time": "2019-05-23T03:11:16.000+0000",	// 创建时间 
+			"status": 1,	// 状态（1=正常、2=禁用）
+			"sort": 3		// 排序值（手机端按照排序值的大小从小到大进行前后排列）
+		},
+		"page": null
+	}
+```
+
+
+---
+### 5、查 - 列表
+- 接口
+``` api
+	/SysSwiper/getList
+```
+- 参数(参数为null或者0时代表不限制条件)
+``` p
+	{String}		title=""			标题，模糊查询
+	{int}			status=1			状态（1=正常、2=禁用）
+```
+- 返回 
+``` js
+	{
+		"code": 200,
+		"msg": "ok",
+		"data": [
+			// 数据列表，格式参考见上  
+		],
+		"dataCount": 100	// 数据总数
+	}
+```
+
+
+
+
+
+
+
+
+
+
diff --git a/project/user.md b/project/user.md
@@ -0,0 +1,88 @@
+# 用户相关
+
+用户模块相关接口
+
+---
+
+### 1、返回当前用户的资料 
+- 接口
+``` api
+	/SysUser/currLogin
+```
+- 返回
+``` js
+	{
+		"code": 200,
+		"msg": "ok",
+		"data": {
+			"id": 10001,			// 账号id
+			"username": "root",		// 昵称
+			"password": "********",	// 密码
+			"sex": 1,				// 性别
+			"avatar": "https://xxx.com/1.png",		// 头像地址
+			"openid": null,		// openid
+			"phone": null,		// 电话
+			"status": 1,		// 状态（1=正常，2=封禁）	
+			"role_id": 1,		// 所属角色id
+			"create_type": 11,	// 账号创建方式
+			"create_time": "2019-05-21T09:15:13.000+0000",	// 账号创建时间
+			"login_time": "2019-07-11T02:12:28.000+0000",	// 最后登录时间
+			"login_ip": "127.0.0.1",				// 最后登录ip
+			"login_count": 432,					// 总登录次数 
+		},
+		"page": null
+	}
+```
+
+
+--- 
+### 2、当前用户修改资料
+- 接口
+``` api
+	/SysUser/updateInfo
+```
+- 参数
+``` p 
+	{String}	avatar = ""				头像
+	{String}	username = ""			昵称
+	{int}		sex = 1					性别
+	{String}	phone = ""				联系电话
+	{String}	introduce = ""			个人介绍
+```
+- 返回 
+@import(res)
+
+
+--- 
+### 3、根据旧密码修改新密码
+- 接口：
+``` api
+	/SysUser/updatePassword
+```
+- 参数: 
+``` p
+	{String}	old_pwd		旧密码
+	{String}	new_pwd		新密码
+```
+- 返回 
+@import(res)
+
+--- 
+### 4、直接修改新密码
+- 接口
+``` api
+	/SysUser/updatePassword2
+```
+- 参数
+``` p
+	{String}	new_pwd		新密码
+```
+- 返回 
+@import(res)
+
+
+
+
+
+
+