mirror/yapi
2
0
Fork 0
mirror of https://github.com/YMFE/yapi.git synced 2025-03-07 14:16:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'dev' of gitlab.corp.qunar.com:mfe/yapi into dev

Browse Source
This commit is contained in:
zwjamnsss 2017-08-15 21:13:15 +08:00
commit c83184df45
27 changed files with 1443 additions and 701 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

102
client/containers/Group/MemberList/MemberList.js
View File

@ -1,12 +1,110 @@
import React, { Component } from 'react';
import { Table } from 'antd';
import PropTypes from 'prop-types';
import { connect } from 'react-redux';
import { Select, Button } from 'antd';
import './MemberList.scss'
import { autobind } from 'core-decorators';
import { fetchGroupMemberList, fetchGroupMsg } from '../../../reducer/modules/group.js'
const Option = Select.Option;
@connect(
state => {
return {
currGroup: state.group.currGroup,
uid: state.user.uid,
role: state.group.role
}
},
{
fetchGroupMemberList,
fetchGroupMsg
}
)
class MemberList extends Component {
constructor(props) {
super(props);
this.state = {
userInfo: [],
role: ''
}
}
static propTypes = {
currGroup: PropTypes.object,
uid: PropTypes.number,
fetchGroupMemberList: PropTypes.func,
fetchGroupMsg: PropTypes.func,
role: PropTypes.string
}
@autobind
handleChange(value) {
console.log(`selected ${value}`);
}
componentWillReceiveProps(nextProps) {
if (this.props.currGroup !== nextProps.currGroup) {
this.props.fetchGroupMemberList(nextProps.currGroup._id).then((res) => {
this.setState({
userInfo: res.payload.data.data
});
});
this.props.fetchGroupMsg(nextProps.currGroup._id).then((res) => {
this.setState({
role: res.payload.data.data.role
});
})
}
}
componentDidMount() {
const currGroupId = this.props.currGroup._id;
this.props.fetchGroupMsg(currGroupId).then((res) => {
this.setState({
role: res.payload.data.data.role
});
})
this.props.fetchGroupMemberList(currGroupId).then((res) => {
this.setState({
userInfo: res.payload.data.data
});
});
}
render() {
console.log(this.state);
const columns = [{
title: this.props.currGroup.group_name + ' 分组成员 ('+this.state.userInfo.length + ') 人',
dataIndex: 'username',
key: 'username',
render: (text, record) => {
return (<div className="m-user">
<img src={location.protocol + '//' + location.host + '/api/user/avatar?uid=' + record.uid} className="m-user-img" />
<p className="m-user-name">{text}</p>
</div>);
}
}, {
key: 'action',
className: 'member-opration',
render: (text, record) => {
if (this.state.role === 'owner' || this.state.role === 'admin') {
return (
<div>
<Select defaultValue={record.role} className="select" onChange={this.handleChange}>
<Option value="owner">组长</Option>
<Option value="dev">开发者</Option>
</Select>
<Button type="danger" icon="minus" className="btn-danger" />
</div>
)
} else {
return '';
}
}
}];
return (
<div className="m-panel">
<Table columns={columns} dataSource={this.state.userInfo} pagination={false} />
</div>
);
}

22
client/containers/Group/MemberList/MemberList.scss
View File

@ -6,3 +6,25 @@
min-height: 5rem;
margin-top: 0;
}
.member-opration {
text-align: right;
.select {
width: 1.2rem;
}
.btn-danger {
margin-left: .08rem;
}
}
.m-user {
display: flex;
align-items: center;
.m-user-img {
width: .32rem;
height: .32rem;
border-radius: .04rem;
}
.m-user-name {
margin-left: 8px;
}
}

12
client/containers/Project/Interface/InterfaceList/View.js
View File

@ -30,17 +30,17 @@ class View extends Component {
componentDidMount() {
let that = this;
mockEditor({
container: 'req_body_json',
container: 'vreq_body_json',
data: that.props.req_body_form,
onChange: function () {}
})
mockEditor({
container: 'res_body_json',
container: 'vres_body_json',
data: that.props.res_body,
onChange: function () {}
})
mockEditor({
container: 'req_query_json',
container: 'vreq_query_json',
data: that.props.req_query,
onChange: function () {}
})
@ -106,15 +106,15 @@ class View extends Component {
</div>
<div className="colQuery">
<span className="colKey">Query：</span>
<div span={18} offset={4} id="req_query_json" style={{ minHeight: "150px" }}></div>
<div span={18} offset={4} id="vreq_query_json" style={{ minHeight: "150px" }}></div>
</div>
<div className="colBody">
<span className="colKey">请求Body：</span>
<div span={18} offset={4} id="req_body_json" style={{ minHeight: "300px" }}></div>
<div span={18} offset={4} id="vreq_body_json" style={{ minHeight: "300px" }}></div>
</div>
<div className="colBody">
<span className="colKey">响应Body：</span>
<div span={18} offset={4} id="res_body_json" style={{ minHeight: "300px" }}></div>
<div span={18} offset={4} id="vres_body_json" style={{ minHeight: "300px" }}></div>
</div>

39
client/reducer/modules/group.js
View File

@ -3,11 +3,15 @@ import axios from 'axios';
// Actions
const FETCH_GROUP_LIST = 'yapi/group/FETCH_GROUP_LIST';
const SET_CURR_GROUP = 'yapi/group/SET_CURR_GROUP';
const FETCH_GROUP_MEMBER = 'yapi/group/FETCH_GROUP_MEMBER';
const FETCH_GROUP_MSG = 'yapi/group/FETCH_GROUP_MSG';
// Reducer
const initialState = {
groupList: [],
currGroup: { group_name: '' }
currGroup: { group_name: '' },
member: [],
role: ''
};
export default (state = initialState, action) => {
@ -24,12 +28,45 @@ export default (state = initialState, action) => {
currGroup: action.payload
};
}
case FETCH_GROUP_MEMBER: {
return {
...state,
member: action.payload.data.data
};
}
case FETCH_GROUP_MSG: {
console.log(action.payload.data.data.role);
return {
...state,
role: action.payload.data.data.role
};
}
default:
return state;
}
};
// 获取 group 信息 (权限信息)
export function fetchGroupMsg(id) {
return {
type: FETCH_GROUP_MSG,
payload: axios.get('/api/group/get', {
params: { id }
})
}
}
// 获取分组成员列表
export function fetchGroupMemberList(id) {
return {
type: FETCH_GROUP_MEMBER,
payload: axios.get('/api/group/get_member_list', {
params: { id }
})
}
}
// Action Creators
export function fetchGroupList() {
return {

61
server/controllers/base.js
View File

@ -26,7 +26,7 @@ class baseController {
'/api/user/status',
'/api/user/logout'
];
if (ignoreRouter.indexOf(ctx.path) > -1) {
if (ignoreRouter.indexOf(ctx.path) > -1) {
this.$auth = true;
} else {
await this.checkLogin(ctx);
@ -82,24 +82,18 @@ class baseController {
getUsername() {
return this.$user.username;
}
/**
*
* @param {*} id type对应的id
* @param {*} type enum[interface, project, group]
* @param {*} action enum[ danger , edit ] danger只有owner或管理员才能操作,edit只要是dev或以上就能执行
*/
async checkAuth(id, type, action) {
async getProjectRole(id, type) {
let result = {};
try {
if (this.getRole() === 'admin') {
return true;
return 'admin';
}
if (type === 'interface') {
let interfaceInst = yapi.getInst(interfaceModel);
let interfaceData = await interfaceInst.get(id)
result.interfaceData = interfaceData;
if (interfaceData.uid === this.getUid()) {
return true;
return 'owner';
}
type = 'project';
id = interfaceData.project_id;
@ -107,10 +101,10 @@ class baseController {
if (type === 'project') {
let projectInst = yapi.getInst(projectModel);
let projectData = await projectInst.get(id);
if(projectData.uid === this.getUid()){
return true;
}
let projectData = await projectInst.get(id);
if (projectData.uid === this.getUid()) {
return 'owner';
}
let memberData = _.find(projectData.members, (m) => {
if (m.uid === this.getUid()) {
return true;
@ -118,11 +112,10 @@ class baseController {
})
if (memberData && memberData.role) {
if(action === 'danger' && memberData.role === 'owner'){
return true;
}
if(action === 'edit'){
return true;
if (memberData.role === 'owner') {
return 'owner';
}else {
return 'dev';
}
}
type = 'group';
@ -138,22 +131,40 @@ class baseController {
}
})
if (groupMemberData && groupMemberData.role) {
if(action === 'danger' && groupMemberData.role === 'owner'){
return true;
}
if(action === 'edit'){
return true;
if (groupMemberData.role === 'owner') {
return 'owner';
}else{
return 'dev'
}
}
}
return false;
return 'member';
}
catch (e) {
yapi.commons.log(e.message, 'error')
return false;
}
}
/**
*
* @param {*} id type对应的id
* @param {*} type enum[interface, project, group]
* @param {*} action enum[ danger , edit ] danger只有owner或管理员才能操作,edit只要是dev或以上就能执行
*/
async checkAuth(id, type, action) {
let role = await this.getProjectRole(id, type);
if(action === 'danger'){
if(role === 'admin' || role === 'owner'){
return true;
}
}else if(action === 'edit'){
if(role === 'admin' || role === 'owner' || role === 'dev'){
return true;
}
}
return false;
}
}
module.exports = baseController;

75
server/controllers/group.js
View File

@ -9,6 +9,33 @@ class groupController extends baseController {
super(ctx);
}
/**
* 添加项目分组
* @interface /group/get
* @method GET
* @category group
* @foldnumber 10
* @param {String} id 项目分组ID
* @returns {Object}
* @example
*/
async get(ctx) {
try {
let params = ctx.request.query;
if (!params.id) {
return ctx.body = yapi.commons.resReturn(null, 400, '分组id不能为空');
}
let groupInst = yapi.getInst(groupModel);
let result = await groupInst.getGroupById(params.id);
result = result.toObject();
result.role = await this.getProjectRole(params.id, 'group');
ctx.body = yapi.commons.resReturn(result);
} catch (e) {
ctx.body = yapi.commons.resReturn(null, 400, e.message)
}
}
/**
* 添加项目分组
* @interface /group/add
@ -16,9 +43,9 @@ class groupController extends baseController {
* @category group
* @foldnumber 10
* @param {String} group_name 项目分组名称，不能为空
* @param {String} [group_desc] 项目分组描述
* @param {String} [group_desc] 项目分组描述
* @param {String} owner_uid 组长uid
* @returns {Object}
* @returns {Object}
* @example ./api/group/add.json
*/
async add(ctx) {
@ -38,12 +65,12 @@ class groupController extends baseController {
return ctx.body = yapi.commons.resReturn(null, 400, '项目分组名不能为空');
}
if(!params.owner_uid){
if (!params.owner_uid) {
return ctx.body = yapi.commons.resReturn(null, 400, '项目分组必须添加一个组长');
}
let groupUserdata = await this.getUserdata(params.owner_uid, 'owner');
if(groupUserdata === null){
if (groupUserdata === null) {
return ctx.body = yapi.commons.resReturn(null, 400, '组长uid不存在')
}
let groupInst = yapi.getInst(groupModel);
@ -74,11 +101,11 @@ class groupController extends baseController {
}
async getUserdata(uid, role){
async getUserdata(uid, role) {
role = role || 'dev';
let userInst = yapi.getInst(userModel);
let userData = await userInst.findById(uid);
if(!userData){
if (!userData) {
return null;
}
return {
@ -98,12 +125,14 @@ class groupController extends baseController {
* @foldnumber 10
* @param {String} id 项目分组id
* @param {String} member_uid 项目分组成员uid
* @returns {Object}
* @example
* @returns {Object}
* @example
*/
async addMember(ctx){
async addMember(ctx){
let params = ctx.request.body;
let groupInst = yapi.getInst(groupModel);
if (!params.member_uid) {
@ -118,10 +147,10 @@ class groupController extends baseController {
return ctx.body = yapi.commons.resReturn(null, 400, '成员已存在');
}
let groupUserdata = await this.getUserdata(params.member_uid);
if(groupUserdata === null){
if (groupUserdata === null) {
return ctx.body = yapi.commons.resReturn(null, 400, '组长uid不存在')
}
if(groupUserdata._role === 'admin'){
if (groupUserdata._role === 'admin') {
return ctx.body = yapi.commons.resReturn(null, 400, '不能邀请管理员')
}
delete groupUserdata._role;
@ -142,11 +171,11 @@ class groupController extends baseController {
* @foldnumber 10
* @param {String} id 项目分组id
* @param {String} member_uid 项目分组成员uid
* @param {String} role 组长uid
* @returns {Object}
* @example
* @param {String} role 权限 ['owner'|'dev']
* @returns {Object}
* @example
*/
async changeMemberRole(ctx){
async changeMemberRole(ctx) {
let params = ctx.request.body;
let groupInst = yapi.getInst(groupModel);
if (!params.member_uid) {
@ -179,8 +208,8 @@ class groupController extends baseController {
* @category group
* @foldnumber 10
* @param {String} id 项目分组id
* @returns {Object}
* @example
* @returns {Object}
* @example
*/
async getMemberList(ctx) {
@ -206,8 +235,8 @@ class groupController extends baseController {
* @foldnumber 10
* @param {String} id 项目分组id
* @param {String} member_uid 项目分组成员uid
* @returns {Object}
* @example
* @returns {Object}
* @example
*/
async delMember(ctx) {
@ -241,7 +270,7 @@ class groupController extends baseController {
* @method get
* @category group
* @foldnumber 10
* @returns {Object}
* @returns {Object}
* @example ./api/group/list.json
*/
async list(ctx) {
@ -261,7 +290,7 @@ class groupController extends baseController {
* @param {String} id 项目分组id
* @category group
* @foldnumber 10
* @returns {Object}
* @returns {Object}
* @example ./api/group/del.json
*/
async del(ctx) {
@ -300,7 +329,7 @@ class groupController extends baseController {
* @param {String} group_desc 项目分组描述
* @category group
* @foldnumber 10
* @returns {Object}
* @returns {Object}
* @example ./api/group/up.json
*/
async up(ctx) {
@ -329,4 +358,4 @@ class groupController extends baseController {
}
}
module.exports = groupController;
module.exports = groupController;

3
server/controllers/project.js
View File

@ -272,6 +272,9 @@ class projectController extends baseController {
}
try {
let result = await this.Model.get(params.id);
result = result.toObject();
delete result.members;
result.role = await this.getProjectRole(params.id, 'project');
ctx.body = yapi.commons.resReturn(result);
} catch (e) {
ctx.body = yapi.commons.resReturn(null, 402, e.message);

6
server/models/group.js
View File

@ -35,6 +35,12 @@ class groupModel extends baseModel {
}).exec();
}
getGroupById(id) {
return this.model.findOne({
_id: id
}).select("uid group_name group_desc add_time up_time").exec();
}
checkRepeat(name) {
return this.model.count({
group_name: name

4
server/router.js
View File

@ -91,6 +91,10 @@ const routerConfig = {
"action": "getMemberList",
"path": "get_member_list",
"method": "get"
},{
action: 'get',
path: 'get',
method: 'get'
}
],
"user": [

149
server_dist/controllers/base.js
View File

@ -219,17 +219,10 @@ var baseController = function () {
value: function getUsername() {
return this.$user.username;
}
/**
*
* @param {*} id type对应的id
* @param {*} type enum[interface, project, group]
* @param {*} action enum[ danger , edit ] danger只有owner或管理员才能操作,edit只要是dev或以上就能执行
*/
}, {
key: 'checkAuth',
key: 'getProjectRole',
value: function () {
var _ref4 = (0, _asyncToGenerator3.default)(_regenerator2.default.mark(function _callee4(id, type, action) {
var _ref4 = (0, _asyncToGenerator3.default)(_regenerator2.default.mark(function _callee4(id, type) {
var _this = this;
var result, interfaceInst, interfaceData, projectInst, projectData, memberData, groupInst, groupData, groupMemberData;
@ -245,7 +238,7 @@ var baseController = function () {
break;
}
return _context4.abrupt('return', true);
return _context4.abrupt('return', 'admin');
case 4:
if (!(type === 'interface')) {
@ -267,7 +260,7 @@ var baseController = function () {
break;
}
return _context4.abrupt('return', true);
return _context4.abrupt('return', 'owner');
case 12:
type = 'project';
@ -275,7 +268,7 @@ var baseController = function () {
case 14:
if (!(type === 'project')) {
_context4.next = 29;
_context4.next = 30;
break;
}
@ -291,7 +284,7 @@ var baseController = function () {
break;
}
return _context4.abrupt('return', true);
return _context4.abrupt('return', 'owner');
case 21:
memberData = _underscore2.default.find(projectData.members, function (m) {
@ -301,40 +294,35 @@ var baseController = function () {
});
if (!(memberData && memberData.role)) {
_context4.next = 28;
break;
}
if (!(memberData.role === 'owner')) {
_context4.next = 27;
break;
}
if (!(action === 'danger' && memberData.role === 'owner')) {
_context4.next = 25;
break;
}
return _context4.abrupt('return', true);
case 25:
if (!(action === 'edit')) {
_context4.next = 27;
break;
}
return _context4.abrupt('return', true);
return _context4.abrupt('return', 'owner');
case 27:
return _context4.abrupt('return', 'dev');
case 28:
type = 'group';
id = projectData.group_id;
case 29:
case 30:
if (!(type === 'group')) {
_context4.next = 40;
_context4.next = 42;
break;
}
groupInst = _yapi2.default.getInst(_group2.default);
_context4.next = 33;
_context4.next = 34;
return groupInst.get(id);
case 33:
case 34:
groupData = _context4.sent;
groupMemberData = _underscore2.default.find(groupData.members, function (m) {
if (m.uid === _this.getUid()) {
@ -343,47 +331,110 @@ var baseController = function () {
});
if (!(groupMemberData && groupMemberData.role)) {
_context4.next = 40;
_context4.next = 42;
break;
}
if (!(action === 'danger' && groupMemberData.role === 'owner')) {
_context4.next = 38;
if (!(groupMemberData.role === 'owner')) {
_context4.next = 41;
break;
}
return _context4.abrupt('return', true);
return _context4.abrupt('return', 'owner');
case 38:
if (!(action === 'edit')) {
_context4.next = 40;
break;
}
case 41:
return _context4.abrupt('return', 'dev');
return _context4.abrupt('return', true);
case 42:
return _context4.abrupt('return', 'member');
case 40:
return _context4.abrupt('return', false);
case 43:
_context4.prev = 43;
case 45:
_context4.prev = 45;
_context4.t0 = _context4['catch'](1);
_yapi2.default.commons.log(_context4.t0.message, 'error');
return _context4.abrupt('return', false);
case 47:
case 49:
case 'end':
return _context4.stop();
}
}
}, _callee4, this, [[1, 43]]);
}, _callee4, this, [[1, 45]]);
}));
function checkAuth(_x4, _x5, _x6) {
function getProjectRole(_x4, _x5) {
return _ref4.apply(this, arguments);
}
return getProjectRole;
}()
/**
*
* @param {*} id type对应的id
* @param {*} type enum[interface, project, group]
* @param {*} action enum[ danger , edit ] danger只有owner或管理员才能操作,edit只要是dev或以上就能执行
*/
}, {
key: 'checkAuth',
value: function () {
var _ref5 = (0, _asyncToGenerator3.default)(_regenerator2.default.mark(function _callee5(id, type, action) {
var role;
return _regenerator2.default.wrap(function _callee5$(_context5) {
while (1) {
switch (_context5.prev = _context5.next) {
case 0:
_context5.next = 2;
return this.getProjectRole(id, type);
case 2:
role = _context5.sent;
if (!(action === 'danger')) {
_context5.next = 8;
break;
}
if (!(role === 'admin' || role === 'owner')) {
_context5.next = 6;
break;
}
return _context5.abrupt('return', true);
case 6:
_context5.next = 11;
break;
case 8:
if (!(action === 'edit')) {
_context5.next = 11;
break;
}
if (!(role === 'admin' || role === 'owner' || role === 'dev')) {
_context5.next = 11;
break;
}
return _context5.abrupt('return', true);
case 11:
return _context5.abrupt('return', false);
case 12:
case 'end':
return _context5.stop();
}
}
}, _callee5, this);
}));
function checkAuth(_x6, _x7, _x8) {
return _ref5.apply(this, arguments);
}
return checkAuth;
}()
}]);

630
server_dist/controllers/group.js
View File

File diff suppressed because it is too large Load Diff

18
server_dist/controllers/project.js
View File

@ -648,22 +648,30 @@ var projectController = function (_baseController) {
case 6:
result = _context6.sent;
result = result.toObject();
delete result.members;
_context6.next = 11;
return this.getProjectRole(params.id, 'project');
case 11:
result.role = _context6.sent;
ctx.body = _yapi2.default.commons.resReturn(result);
_context6.next = 13;
_context6.next = 18;
break;
case 10:
_context6.prev = 10;
case 15:
_context6.prev = 15;
_context6.t0 = _context6['catch'](3);
ctx.body = _yapi2.default.commons.resReturn(null, 402, _context6.t0.message);
case 13:
case 18:
case 'end':
return _context6.stop();
}
}
}, _callee6, this, [[3, 10]]);
}, _callee6, this, [[3, 15]]);
}));
function get(_x7) {

7
server_dist/models/group.js
View File

@ -73,6 +73,13 @@ var groupModel = function (_baseModel) {
_id: id
}).exec();
}
}, {
key: 'getGroupById',
value: function getGroupById(id) {
return this.model.findOne({
_id: id
}).select("uid group_name group_desc add_time up_time").exec();
}
}, {
key: 'checkRepeat',
value: function checkRepeat(name) {

4
server_dist/router.js
View File

@ -120,6 +120,10 @@ var routerConfig = {
"action": "getMemberList",
"path": "get_member_list",
"method": "get"
}, {
action: 'get',
path: 'get',
method: 'get'
}],
"user": [{
"action": "login",

569
static/doc/api.html
View File

File diff suppressed because it is too large Load Diff

6
static/doc/index.html
View File

@ -175,8 +175,8 @@
var $this = $(this);
$this.removeClass('extend').addClass('fold');
$this.html('折叠代码');
$this.parent().children('.js-code').height('auto');
$this.parent().height('auto');
$this.prev().height('auto');
$this.prev().parent().height('auto');
});
$('.ydoc-example').delegate('.fold', 'click', function() {
var $this = $(this);
@ -184,7 +184,7 @@
EXAMPLE_MAX_HEIGHT = lineHeight * (foldnumber || 6);
$this.removeClass('fold').addClass('extend');
$this.parent().height(EXAMPLE_MAX_HEIGHT); // pre
$this.parent().children('.js-code').height(EXAMPLE_MAX_HEIGHT); // code
$this.prev().height(EXAMPLE_MAX_HEIGHT); // code
$this.html("展开更多……");
});
}

14
static/doc/interface.html
View File

@ -68,23 +68,23 @@
<div class="ydoc-container-content " id="readme">
<article class="markdown-body">
<h2 class="subject" id="快速开始">快速开始 <a class="hashlink" href="#快速开始">#</a></h2><h3 class="subject" id="1_接口管理架构">1 接口管理架构 <a class="hashlink" href="#1_接口管理架构">#</a></h3><p>平台以<strong>项目分组</strong> -&gt; <strong>项目</strong> -&gt; <strong>接口</strong>的划分进行接口组织管理。</p>
<h2 class="subject" id="快速开始">快速开始 <a class="hashlink" href="#快速开始">#</a></h2><h3 class="subject" id="1 接口管理架构">1 接口管理架构 <a class="hashlink" href="#1 接口管理架构">#</a></h3><p>平台以<strong>项目分组</strong> -&gt; <strong>项目</strong> -&gt; <strong>接口</strong>的划分进行接口组织管理。</p>
<p><img src="http://upload-images.jianshu.io/upload_images/842107-305ba49a60ee1ff5.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" width = "800" style="margin:0px auto;display:block;" alt="图片名称" align=center /></p>
<h4 class="subject" id="1.1_项目分组">1.1 项目分组 <a class="hashlink" href="#1.1_项目分组">#</a></h4><p>登录之后进到项目首页，左边侧边栏显示的即分组列表。</p>
<h4 class="subject" id="1.1 项目分组">1.1 项目分组 <a class="hashlink" href="#1.1 项目分组">#</a></h4><p>登录之后进到项目首页，左边侧边栏显示的即分组列表。</p>
<p><img src="http://upload-images.jianshu.io/upload_images/842107-d90ca4b3242fa760.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" width = "200" style="margin-left:170px;display:block;" alt="图片名称" align=center /></p>
<p>管理员有权限添加或删除分组。</p>
<p><img src="http://upload-images.jianshu.io/upload_images/842107-a0d4d9a98003896a.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" width = "500" style="margin-left:170px;display:block;" alt="图片名称" align=center /></p>
<blockquote>
<p>分组名称具有唯一性</p>
</blockquote>
<h4 class="subject" id="1.2_项目">1.2 项目 <a class="hashlink" href="#1.2_项目">#</a></h4><p>选中不同的分组，右边会显示该分组下的项目列表。</p>
<h4 class="subject" id="1.2 项目">1.2 项目 <a class="hashlink" href="#1.2 项目">#</a></h4><p>选中不同的分组，右边会显示该分组下的项目列表。</p>
<p><img src="http://upload-images.jianshu.io/upload_images/842107-137bcae58b84715e.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" width = "800" style="margin:0px auto;display:block;" alt="图片名称" align=center /></p>
<p>创建项目需要填写项目名称，项目线上域名（添加完成后可配置项目其他环境域名），项目接口基本路径（接口路径前面相同的部分）以及项目描述。</p>
<p><img src="http://upload-images.jianshu.io/upload_images/842107-360a50ddb746f73d.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" width = "800" style="margin:0px auto;display:block;" alt="图片名称" align=center /></p>
<blockquote>
<p>项目『线上域名 + 基本路径』具有唯一性</p>
</blockquote>
<h4 class="subject" id="1.3_接口">1.3 接口 <a class="hashlink" href="#1.3_接口">#</a></h4><p>点击项目名称，进入该项目接口列表。</p>
<h4 class="subject" id="1.3 接口">1.3 接口 <a class="hashlink" href="#1.3 接口">#</a></h4><p>点击项目名称，进入该项目接口列表。</p>
<p><img src="http://upload-images.jianshu.io/upload_images/842107-e858005f714f4889.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" width = "800" style="margin:0px auto;display:block;" alt="图片名称" align=center /></p>
<p>点击编辑，进入接口详情页（之后接口详情页和编辑也会分开），可以编辑接口或者请求测试真实接口。</p>
<p><img src="http://upload-images.jianshu.io/upload_images/842107-78c0ea839619d068.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" width = "800" style="margin:0px auto;display:block;" alt="图片名称" align=center /></p>
@ -134,8 +134,8 @@
var $this = $(this);
$this.removeClass('extend').addClass('fold');
$this.html('折叠代码');
$this.parent().children('.js-code').height('auto');
$this.parent().height('auto');
$this.prev().height('auto');
$this.prev().parent().height('auto');
});
$('.ydoc-example').delegate('.fold', 'click', function() {
var $this = $(this);
@ -143,7 +143,7 @@
EXAMPLE_MAX_HEIGHT = lineHeight * (foldnumber || 6);
$this.removeClass('fold').addClass('extend');
$this.parent().height(EXAMPLE_MAX_HEIGHT); // pre
$this.parent().children('.js-code').height(EXAMPLE_MAX_HEIGHT); // code
$this.prev().height(EXAMPLE_MAX_HEIGHT); // code
$this.html("展开更多……");
});
}

24
static/doc/mock.html
View File

@ -70,7 +70,7 @@
<article class="markdown-body">
<h2 class="subject" id="Mock功能">Mock功能 <a class="hashlink" href="#Mock功能">#</a></h2> <p style='text-indent:2em;line-height:1.8em'>yapi的Mock功能可以根据用户的输入接口信息如协议、URL、接口名、请求头、请求参数、mock规则(<a href="#mock">点击到Mock规则</a>）生成Mock接口，这些接口会自动生成模拟数据，支持复杂的生成逻辑，创建者可以自由构造需要的数据。而且与常见的Mock方式如将Mock写在代码里和JS拦截等相比yapi的Mock在使用场景和效率和复杂度上是相差甚远的，正是由于yapi的Mock是一个第三方平台那么在 团队开发时任何人都可以权限许可下创建、修改接口信息等操作，这对于团队开发是很有好处的。</p>
<h3 class="subject" id="1_Mock步骤">1 Mock步骤 <a class="hashlink" href="#1_Mock步骤">#</a></h3><h4 class="subject" id="1.1_创建接口">1.1 创建接口 <a class="hashlink" href="#1.1_创建接口">#</a></h4><p>通过点击页面上的&quot;+添加接口&quot;</p>
<h3 class="subject" id="1 Mock步骤">1 Mock步骤 <a class="hashlink" href="#1 Mock步骤">#</a></h3><h4 class="subject" id="1.1 创建接口">1.1 创建接口 <a class="hashlink" href="#1.1 创建接口">#</a></h4><p>通过点击页面上的&quot;+添加接口&quot;</p>
<p><img src="http://note.youdao.com/yws/api/personal/file/WEB613bd4f29db038f2b41c03dcfceda2b6?method=download&shareKey=29bfc2b855f6f26ce0079baf567e54cc" width = "800" style="margin:0px auto;display:block;" alt="图片名称" align=center /></p>
<p> 输入协议、URL、接口名、请求头、请求参数、Mock规则（<a href="#mock">点击到Mock规则</a>）等信息。</p>
<p><img src="http://note.youdao.com/yws/api/personal/file/WEB680a37ba304768804b23cf2cf36ed40d?method=download&shareKey=0d750695dce3a4c7abf697fa58d24c57" width = "800" style="margin:0px auto;display:block;" alt="图片名称" align=center /></p>
@ -84,14 +84,14 @@
<p>取到上面的链接在浏览器中请求就可以得到如下结果。</p>
<p><img src="http://note.youdao.com/yws/api/personal/file/WEB1d1f7dc7b83a8cd6f576953cf45e9719?method=download&shareKey=99b4af9baac527b969543dd0a909d2a1" width = "800" style="margin:0px auto;display:block;" alt="图片名称" align=center /></p>
<p><span id = "mock"></span></p>
<h3 class="subject" id="2.1_Mock语法规范">2.1 Mock语法规范 <a class="hashlink" href="#2.1_Mock语法规范">#</a></h3><blockquote>
<h3 class="subject" id="2.1 Mock语法规范">2.1 Mock语法规范 <a class="hashlink" href="#2.1 Mock语法规范">#</a></h3><blockquote>
<p>了解更多Mock详情：<a href="https://github.com/nuysoft/Mock/wiki/Syntax-Specification">Mock.js 官方文档</a></p>
</blockquote>
<p>Mock.js 的语法规范包括两部分：</p>
<p><a href="#DTD">1. 数据模板定义规范（Data Template Definition，DTD）</a></p>
<p><a href="#DPD">2. 数据占位符定义规范（Data Placeholder Definition，DPD）</a></p>
<p><span id = "DTD"></span></p>
<h3 class="subject" id="数据模板定义规范（Data_Template_Definition，DTD）">数据模板定义规范（Data Template Definition，DTD） <a class="hashlink" href="#数据模板定义规范（Data_Template_Definition，DTD）">#</a></h3><p>数据模板中的每个属性由 3 部分构成：属性名、生成规则、属性值：</p>
<h3 class="subject" id="数据模板定义规范（Data Template Definition，DTD）">数据模板定义规范（Data Template Definition，DTD） <a class="hashlink" href="#数据模板定义规范（Data Template Definition，DTD）">#</a></h3><p>数据模板中的每个属性由 3 部分构成：属性名、生成规则、属性值：</p>
<pre><code>// 属性名 name （与生成规则之间用 "|<span class="token string">" 隔开）
// 生成规则 rule（生成规则有7种详见下面的生成规则）
// 属性值 value（可以含有 "</span>@占位符" 同时也指定了最终值的初始值和类型）
@ -107,14 +107,14 @@
'name|count.dcount'<span class="token operator">:</span> value
'name|+step'<span class="token operator">:</span> value
</code></pre><p>下面提供了6种生成规则以及示例包括 String、Number、Boolean、Object、Array：</p>
<h4 class="subject" id="1._属性值是字符串_String">1. 属性值是字符串 String <a class="hashlink" href="#1._属性值是字符串_String">#</a></h4><pre><code><span class="token number">1</span>. 'name|min-max'<span class="token operator">:</span> string
<h4 class="subject" id="1. 属性值是字符串 String">1. 属性值是字符串 String <a class="hashlink" href="#1. 属性值是字符串 String">#</a></h4><pre><code><span class="token number">1</span>. 'name|min-max'<span class="token operator">:</span> string
通过重复 string 生成一个字符串，重复次数大于等于 min，小于等于 max。
<span class="token number">2</span>. 'name|count'<span class="token operator">:</span> string
通过重复 string 生成一个字符串，重复次数等于 count。
</code></pre><h4 class="subject" id="2._属性值是数字_Number">2. 属性值是数字 Number <a class="hashlink" href="#2._属性值是数字_Number">#</a></h4><pre><code><span class="token number">1</span>. 'name|+<span class="token number">1</span>'<span class="token operator">:</span> number
</code></pre><h4 class="subject" id="2. 属性值是数字 Number">2. 属性值是数字 Number <a class="hashlink" href="#2. 属性值是数字 Number">#</a></h4><pre><code><span class="token number">1</span>. 'name|+<span class="token number">1</span>'<span class="token operator">:</span> number
属性值自动加 <span class="token number">1</span>，初始值为 number。
@ -140,21 +140,21 @@ Mock.mock(<span class="token punctuation">{</span>
<span class="token property">"number3"</span><span class="token operator">:</span> <span class="token number">123.777</span><span class="token punctuation">,</span>
<span class="token property">"number4"</span><span class="token operator">:</span> <span class="token number">123.1231091814</span>
<span class="token punctuation">}</span>
</code></pre><h4 class="subject" id="3._属性值是布尔型_Boolean">3. 属性值是布尔型 Boolean <a class="hashlink" href="#3._属性值是布尔型_Boolean">#</a></h4><pre><code><span class="token number">1</span>. 'name|<span class="token number">1</span>'<span class="token operator">:</span> boolean
</code></pre><h4 class="subject" id="3. 属性值是布尔型 Boolean">3. 属性值是布尔型 Boolean <a class="hashlink" href="#3. 属性值是布尔型 Boolean">#</a></h4><pre><code><span class="token number">1</span>. 'name|<span class="token number">1</span>'<span class="token operator">:</span> boolean
随机生成一个布尔值，值为 <span class="token boolean">true</span> 的概率是 <span class="token number">1</span>/<span class="token number">2</span>，值为 <span class="token boolean">false</span> 的概率同样是 <span class="token number">1</span>/<span class="token number">2</span>。
<span class="token number">2</span>. 'name|min-max'<span class="token operator">:</span> value
随机生成一个布尔值，值为 value 的概率是 min / (min + max<span class="token punctuation">)</span>，值为 !value 的概率是 max / (min + max<span class="token punctuation">)</span>。
</code></pre><h4 class="subject" id="4._属性值是对象_Object">4. 属性值是对象 Object <a class="hashlink" href="#4._属性值是对象_Object">#</a></h4><pre><code><span class="token number">1</span>. 'name|count'<span class="token operator">:</span> object
</code></pre><h4 class="subject" id="4. 属性值是对象 Object">4. 属性值是对象 Object <a class="hashlink" href="#4. 属性值是对象 Object">#</a></h4><pre><code><span class="token number">1</span>. 'name|count'<span class="token operator">:</span> object
从属性值 object 中随机选取 count 个属性。
<span class="token number">2</span>. 'name|min-max'<span class="token operator">:</span> object
从属性值 object 中随机选取 min 到 max 个属性。
</code></pre><h4 class="subject" id="5._属性值是数组_Array">5. 属性值是数组 Array <a class="hashlink" href="#5._属性值是数组_Array">#</a></h4><pre><code><span class="token number">1</span>. 'name|<span class="token number">1</span>'<span class="token operator">:</span> array
</code></pre><h4 class="subject" id="5. 属性值是数组 Array">5. 属性值是数组 Array <a class="hashlink" href="#5. 属性值是数组 Array">#</a></h4><pre><code><span class="token number">1</span>. 'name|<span class="token number">1</span>'<span class="token operator">:</span> array
从属性值 array 中随机选取 <span class="token number">1</span> 个元素，作为最终值。
@ -170,7 +170,7 @@ Mock.mock(<span class="token punctuation">{</span>
通过重复属性值 array 生成一个新数组，重复次数为 count。
</code></pre><p><span id = "DPD"></span></p>
<h3 class="subject" id="数据占位符定义规范（Data_Placeholder_Definition，DPD）">数据占位符定义规范（Data Placeholder Definition，DPD） <a class="hashlink" href="#数据占位符定义规范（Data_Placeholder_Definition，DPD）">#</a></h3><pre><code>占位符 只是在属性值字符串中占个位置，并不出现在最终的属性值中。
<h3 class="subject" id="数据占位符定义规范（Data Placeholder Definition，DPD）">数据占位符定义规范（Data Placeholder Definition，DPD） <a class="hashlink" href="#数据占位符定义规范（Data Placeholder Definition，DPD）">#</a></h3><pre><code>占位符 只是在属性值字符串中占个位置，并不出现在最终的属性值中。
占位符 的格式为：
@ -240,8 +240,8 @@ name<span class="token operator">:</span> <span class="token punctuation">{</spa
var $this = $(this);
$this.removeClass('extend').addClass('fold');
$this.html('折叠代码');
$this.parent().children('.js-code').height('auto');
$this.parent().height('auto');
$this.prev().height('auto');
$this.prev().parent().height('auto');
});
$('.ydoc-example').delegate('.fold', 'click', function() {
var $this = $(this);
@ -249,7 +249,7 @@ name<span class="token operator">:</span> <span class="token punctuation">{</spa
EXAMPLE_MAX_HEIGHT = lineHeight * (foldnumber || 6);
$this.removeClass('fold').addClass('extend');
$this.parent().height(EXAMPLE_MAX_HEIGHT); // pre
$this.parent().children('.js-code').height(EXAMPLE_MAX_HEIGHT); // code
$this.prev().height(EXAMPLE_MAX_HEIGHT); // code
$this.html("展开更多……");
});
}

16
static/doc/source/app.js
View File

@ -129,8 +129,7 @@ $(document).ready(function() {
});
$('.markdown-body pre').map(function(i, item) {
$(item).addClass('ydoc-example').append('<div class="ui-copy js-copy" data-clipboard-action="copy" data-clipboard-target=".js-code-' + i + '" data-copy-number="' + i + '">copy</div><div class="copy-tip copy-tip-' + i + '">已复制</div>');
$(item).children('code').addClass('js-code-'+i);
$(item).addClass('ydoc-example');
});
var winHeight = $(window).height() - 44,
@ -214,17 +213,4 @@ $(document).ready(function() {
return false;
}
}
// 代码复制功能
var clipboard = new Clipboard('.js-copy');
clipboard.on('success', function(e) {
var copyNumber = $(e.trigger).attr('data-copy-number');
$('.copy-tip-'+copyNumber).show();
setTimeout(function() {
$('.copy-tip-'+copyNumber).hide();
}, 1000);
e.clearSelection();
});
});

2
static/doc/source/code.css
View File

File diff suppressed because one or more lines are too long

2
static/doc/source/main.css
View File

File diff suppressed because one or more lines are too long

12
static/doc/source/main.js
View File

File diff suppressed because one or more lines are too long

63
static/doc/static/server/controllers/base.js.html vendored
View File

@ -53,7 +53,7 @@ class baseController {
'/api/user/status',
'/api/user/logout'
];
if (ignoreRouter.indexOf(ctx.path) > -1) {
if (ignoreRouter.indexOf(ctx.path) > -1) {
this.$auth = true;
} else {
await this.checkLogin(ctx);
@ -99,7 +99,7 @@ class baseController {
result.server_ip = yapi.WEBCONFIG.server_ip;
return ctx.body = yapi.commons.resReturn(result);
}
return ctx.body = yapi.commons.resReturn(null, 300, 'Please login.');
return ctx.body = yapi.commons.resReturn(null, 40011, '请登录...');
}
getRole() {
@ -109,24 +109,18 @@ class baseController {
getUsername() {
return this.$user.username;
}
/**
*
* @param {*} id type对应的id
* @param {*} type enum[interface, project, group]
* @param {*} action enum[ danger , edit ] danger只有owner或管理员才能操作,edit只要是dev或以上就能执行
*/
async checkAuth(id, type, action) {
async getProjectRole(id, type) {
let result = {};
try {
if (this.getRole() === 'admin') {
return true;
return 'admin';
}
if (type === 'interface') {
let interfaceInst = yapi.getInst(interfaceModel);
let interfaceData = await interfaceInst.get(id)
result.interfaceData = interfaceData;
if (interfaceData.uid === this.getUid()) {
return true;
return 'owner';
}
type = 'project';
id = interfaceData.project_id;
@ -134,10 +128,10 @@ class baseController {
if (type === 'project') {
let projectInst = yapi.getInst(projectModel);
let projectData = await projectInst.get(id);
if(projectData.uid === this.getUid()){
return true;
}
let projectData = await projectInst.get(id);
if (projectData.uid === this.getUid()) {
return 'owner';
}
let memberData = _.find(projectData.members, (m) => {
if (m.uid === this.getUid()) {
return true;
@ -145,11 +139,10 @@ class baseController {
})
if (memberData && memberData.role) {
if(action === 'danger' && memberData.role === 'owner'){
return true;
}
if(action === 'edit'){
return true;
if (memberData.role === 'owner') {
return 'owner';
}else {
return 'dev';
}
}
type = 'group';
@ -165,22 +158,40 @@ class baseController {
}
})
if (groupMemberData && groupMemberData.role) {
if(action === 'danger' && groupMemberData.role === 'owner'){
return true;
}
if(action === 'edit'){
return true;
if (groupMemberData.role === 'owner') {
return 'owner';
}else{
return 'dev'
}
}
}
return false;
return 'member';
}
catch (e) {
yapi.commons.log(e.message, 'error')
return false;
}
}
/**
*
* @param {*} id type对应的id
* @param {*} type enum[interface, project, group]
* @param {*} action enum[ danger , edit ] danger只有owner或管理员才能操作,edit只要是dev或以上就能执行
*/
async checkAuth(id, type, action) {
let role = await this.getProjectRole(id, type);
if(action === 'danger'){
if(role === 'admin' || role === 'owner'){
return true;
}
}else if(action === 'edit'){
if(role === 'admin' || role === 'owner' || role === 'dev'){
return true;
}
}
return false;
}
}
module.exports = baseController;

111
static/doc/static/server/controllers/group.js.html vendored
View File

@ -36,6 +36,33 @@ class groupController extends baseController {
super(ctx);
}
/**
* 添加项目分组
* @interface /group/get
* @method GET
* @category group
* @foldnumber 10
* @param {String} id 项目分组ID
* @returns {Object}
* @example
*/
async get(ctx) {
try {
let params = ctx.request.query;
if (!params.id) {
return ctx.body = yapi.commons.resReturn(null, 400, '分组id不能为空');
}
let groupInst = yapi.getInst(groupModel);
let result = await groupInst.getGroupById(params.id);
result = result.toObject();
result.role = await this.getProjectRole(params.id, 'group');
ctx.body = yapi.commons.resReturn(result);
} catch (e) {
ctx.body = yapi.commons.resReturn(null, 400, e.message)
}
}
/**
* 添加项目分组
* @interface /group/add
@ -43,9 +70,9 @@ class groupController extends baseController {
* @category group
* @foldnumber 10
* @param {String} group_name 项目分组名称，不能为空
* @param {String} [group_desc] 项目分组描述
* @param {String} [group_desc] 项目分组描述
* @param {String} owner_uid 组长uid
* @returns {Object}
* @returns {Object}
* @example ./api/group/add.json
*/
async add(ctx) {
@ -65,12 +92,12 @@ class groupController extends baseController {
return ctx.body = yapi.commons.resReturn(null, 400, '项目分组名不能为空');
}
if(!params.owner_uid){
if (!params.owner_uid) {
return ctx.body = yapi.commons.resReturn(null, 400, '项目分组必须添加一个组长');
}
let groupUserdata = await this.getUserdata(params.owner_uid, 'owner');
if(groupUserdata === null){
if (groupUserdata === null) {
return ctx.body = yapi.commons.resReturn(null, 400, '组长uid不存在')
}
let groupInst = yapi.getInst(groupModel);
@ -101,14 +128,15 @@ class groupController extends baseController {
}
async getUserdata(uid, role){
async getUserdata(uid, role) {
role = role || 'dev';
let userInst = yapi.getInst(userModel);
let userData = await userInst.findById(uid);
if(!userData){
if (!userData) {
return null;
}
return {
_role: userData.role,
role: role,
uid: userData._id,
username: userData.username,
@ -116,7 +144,22 @@ class groupController extends baseController {
}
}
async addMember(ctx){
/**
* 添加项目分组成员
* @interface /group/add_member
* @method POST
* @category group
* @foldnumber 10
* @param {String} id 项目分组id
* @param {String} member_uid 项目分组成员uid
* @returns {Object}
* @example
*/
async addMember(ctx){
let params = ctx.request.body;
let groupInst = yapi.getInst(groupModel);
if (!params.member_uid) {
@ -131,9 +174,13 @@ class groupController extends baseController {
return ctx.body = yapi.commons.resReturn(null, 400, '成员已存在');
}
let groupUserdata = await this.getUserdata(params.member_uid);
if(groupUserdata === null){
if (groupUserdata === null) {
return ctx.body = yapi.commons.resReturn(null, 400, '组长uid不存在')
}
if (groupUserdata._role === 'admin') {
return ctx.body = yapi.commons.resReturn(null, 400, '不能邀请管理员')
}
delete groupUserdata._role;
try {
let result = await groupInst.addMember(params.id, groupUserdata);
ctx.body = yapi.commons.resReturn(result);
@ -142,7 +189,20 @@ class groupController extends baseController {
}
}
async changeMemberRole(ctx){
/**
* 修改项目分组成员角色
* @interface /group/change_member_role
* @method POST
* @category group
* @foldnumber 10
* @param {String} id 项目分组id
* @param {String} member_uid 项目分组成员uid
* @param {String} role 权限 ['owner'|'dev']
* @returns {Object}
* @example
*/
async changeMemberRole(ctx) {
let params = ctx.request.body;
let groupInst = yapi.getInst(groupModel);
if (!params.member_uid) {
@ -155,7 +215,7 @@ class groupController extends baseController {
if (check === 0) {
return ctx.body = yapi.commons.resReturn(null, 400, '分组成员不存在');
}
if (await this.checkAuth(id, 'group', 'danger') !== true) {
if (await this.checkAuth(params.id, 'group', 'danger') !== true) {
return ctx.body = yapi.commons.resReturn(null, 405, '没有权限');
}
@ -168,6 +228,16 @@ class groupController extends baseController {
ctx.body = yapi.commons.resReturn(null, 402, e.message);
}
}
/**
* 获取所有项目成员
* @interface /group/get_member_list
* @method GET
* @category group
* @foldnumber 10
* @param {String} id 项目分组id
* @returns {Object}
* @example
*/
async getMemberList(ctx) {
let params = ctx.request.query;
@ -184,6 +254,18 @@ class groupController extends baseController {
}
}
/**
* 删除项目成员
* @interface /group/del_member
* @method POST
* @category group
* @foldnumber 10
* @param {String} id 项目分组id
* @param {String} member_uid 项目分组成员uid
* @returns {Object}
* @example
*/
async delMember(ctx) {
let params = ctx.request.body;
let groupInst = yapi.getInst(groupModel);
@ -197,7 +279,7 @@ class groupController extends baseController {
if (check === 0) {
return ctx.body = yapi.commons.resReturn(null, 400, '分组成员不存在');
}
if (await this.checkAuth(id, 'group', 'danger') !== true) {
if (await this.checkAuth(params.id, 'group', 'danger') !== true) {
return ctx.body = yapi.commons.resReturn(null, 405, '没有权限');
}
@ -215,7 +297,7 @@ class groupController extends baseController {
* @method get
* @category group
* @foldnumber 10
* @returns {Object}
* @returns {Object}
* @example ./api/group/list.json
*/
async list(ctx) {
@ -235,7 +317,7 @@ class groupController extends baseController {
* @param {String} id 项目分组id
* @category group
* @foldnumber 10
* @returns {Object}
* @returns {Object}
* @example ./api/group/del.json
*/
async del(ctx) {
@ -274,7 +356,7 @@ class groupController extends baseController {
* @param {String} group_desc 项目分组描述
* @category group
* @foldnumber 10
* @returns {Object}
* @returns {Object}
* @example ./api/group/up.json
*/
async up(ctx) {
@ -304,6 +386,7 @@ class groupController extends baseController {
}
module.exports = groupController;
</pre>
</div>
</div>

58
static/doc/static/server/controllers/interface.js.html vendored
View File

@ -50,12 +50,13 @@ class interfaceController extends baseController {
* @param {String} [req_headers[].value] 请求的header信息值
* @param {Boolean} [req_headers[].required] 是否是必须，默认为否
* @param {String} [req_headers[].desc] header描述
* @param {String} [req_params_type] 请求参数方式，有["form", "json", "text", "xml"]四种
* @param {Mixed} [req_params_form] 请求参数,如果请求方式是form，参数是Array数组，其他格式请求参数是字符串
* @param {String} [req_params_form[].name] 请求参数名
* @param {String} [req_params_form[].value] 请求参数值，可填写生成规则（mock）。如@email，随机生成一条email
* @param {String} [req_params_form[].type] 请求参数类型，有["text", "file"]两种
* @param {String} [req_params_other] 非form类型的请求参数可保存到此字段
* @param {String} [req_body_type] 请求参数方式，有["form", "json", "text", "xml"]四种
* @param {Array} [req_params] name, desc两个参数
* @param {Mixed} [req_body_form] 请求参数,如果请求方式是form，参数是Array数组，其他格式请求参数是字符串
* @param {String} [req_body_form[].name] 请求参数名
* @param {String} [req_body_form[].value] 请求参数值，可填写生成规则（mock）。如@email，随机生成一条email
* @param {String} [req_body_form[].type] 请求参数类型，有["text", "file"]两种
* @param {String} [req_body_other] 非form类型的请求参数可保存到此字段
* @param {String} [res_body_type] 相应信息的数据格式，有["json", "text", "xml"]三种
* @param {String} [res_body] 响应信息，可填写任意字符串，如果res_body_type是json,则会调用mock功能
* @param {String} [desc] 接口描述
@ -102,7 +103,7 @@ class interfaceController extends baseController {
desc: params.desc,
method: params.method,
req_headers: params.req_headers,
req_params_type: params.req_params_type,
req_body_type: params.req_body_type,
res_body: params.res_body,
res_body_type: params.res_body_type,
uid: this.getUid(),
@ -110,11 +111,18 @@ class interfaceController extends baseController {
up_time: yapi.commons.time()
};
if (params.req_params_form) {
data.req_params_form = params.req_params_form;
if (params.req_query) {
data.req_query = params.req_query;
}
if (params.req_params_other) {
data.req_params_other = params.req_params_other;
if (params.req_body_form) {
data.req_body_form = params.req_body_form;
}
if (params.req_params) {
data.req_params = params.req_params;
}
if (params.req_body_other) {
data.req_body_other = params.req_body_other;
}
let result = await this.Model.save(data);
@ -188,12 +196,12 @@ class interfaceController extends baseController {
* @param {String} [req_headers[].value] 请求的header信息值
* @param {Boolean} [req_headers[].required] 是否是必须，默认为否
* @param {String} [req_headers[].desc] header描述
* @param {String} [req_params_type] 请求参数方式，有["form", "json", "text", "xml"]四种
* @param {Mixed} [req_params_form] 请求参数,如果请求方式是form，参数是Array数组，其他格式请求参数是字符串
* @param {String} [req_params_form[].name] 请求参数名
* @param {String} [req_params_form[].value] 请求参数值，可填写生成规则（mock）。如@email，随机生成一条email
* @param {String} [req_params_form[].type] 请求参数类型，有["text", "file"]两种
* @param {String} [req_params_other] 非form类型的请求参数可保存到此字段
* @param {String} [req_body_type] 请求参数方式，有["form", "json", "text", "xml"]四种
* @param {Mixed} [req_body_form] 请求参数,如果请求方式是form，参数是Array数组，其他格式请求参数是字符串
* @param {String} [req_body_form[].name] 请求参数名
* @param {String} [req_body_form[].value] 请求参数值，可填写生成规则（mock）。如@email，随机生成一条email
* @param {String} [req_body_form[].type] 请求参数类型，有["text", "file"]两种
* @param {String} [req_body_other] 非form类型的请求参数可保存到此字段
* @param {String} [res_body_type] 相应信息的数据格式，有["json", "text", "xml"]三种
* @param {String} [res_body] 响应信息，可填写任意字符串，如果res_body_type是json,则会调用mock功能
* @param {String} [desc] 接口描述
@ -214,7 +222,7 @@ class interfaceController extends baseController {
params.method = params.method.toUpperCase();
let id = ctx.request.body.id;
if (!id) {
return ctx.body = yapi.commons.resReturn(null, 400, '接口id不能为空');
}
@ -252,11 +260,17 @@ class interfaceController extends baseController {
data.req_headers = params.req_headers;
}
if (params.req_params_form) {
data.req_params_form = params.req_params_form;
if (params.req_body_form) {
data.req_body_form = params.req_body_form;
}
if (params.req_params_other) {
data.req_params_other = params.req_params_other;
if (params.req_params) {
data.req_params = params.req_params;
}
if (params.req_query) {
data.req_query = params.req_query;
}
if (params.req_body_other) {
data.req_body_other = params.req_body_other;
}
if (params.res_body_type) {

83
static/doc/static/server/controllers/interfaceCol.js.html vendored
View File

@ -44,14 +44,18 @@ class interfaceColController extends baseController{
* @category col
* @foldnumber 10
* @param {String} project_id email名称，不能为空
* @returns {Object}
* @example
* @returns {Object}
* @example
*/
async list(ctx){
try {
let id = ctx.query.project_id;
let inst = this.colModel(interfaceColModel);
let result = await inst.list(id);
let result = await this.colModel.list(id);
for(let i=0; i< result.length;i++){
result[i] = result[i].toObject();
result[i].caseList = await this.caseModel.list(result[i]._id)
}
ctx.body = yapi.commons.resReturn(result);
} catch (e) {
ctx.body = yapi.commons.resReturn(null, 402, e.message);
@ -67,8 +71,8 @@ class interfaceColController extends baseController{
* @param {Number} project_id
* @param {String} name
* @param {String} desc
* @returns {Object}
* @example
* @returns {Object}
* @example
*/
async addCol(ctx){
@ -79,14 +83,14 @@ class interfaceColController extends baseController{
project_id: 'number',
desc: 'string'
});
if (!params.project_id) {
return ctx.body = yapi.commons.resReturn(null, 400, '项目id不能为空');
return ctx.body = yapi.commons.resReturn(null, 400, '项目id不能为空');
}
if(!params.name){
return ctx.body = yapi.commons.resReturn(null, 400, '名称不能为空');
return ctx.body = yapi.commons.resReturn(null, 400, '名称不能为空');
}
let result = await this.colModel.save({
name: params.name,
project_id: params.project_id,
@ -109,8 +113,8 @@ class interfaceColController extends baseController{
* @category col
* @foldnumber 10
* @param {String} col_id 接口集id
* @returns {Object}
* @example
* @returns {Object}
* @example
*/
async getCaseList(ctx){
@ -133,17 +137,17 @@ class interfaceColController extends baseController{
* @param {String} casename
* @param {Number} col_id
* @param {Number} project_id
* @param {String} env
* @param {String} env
* @param {String} domain
* @param {String} path
* @param {String} method
* @param {Object} req_query
* @param {Object} req_headers
* @param {String} req_body_type
* @param {Array} req_body_form
* @param {Array} req_body_form
* @param {String} req_body_other
* @returns {Object}
* @example
* @returns {Object}
* @example
*/
async addCase(ctx){
@ -157,23 +161,17 @@ class interfaceColController extends baseController{
domain: 'string',
method: 'string'
});
if (!params.project_id) {
return ctx.body = yapi.commons.resReturn(null, 400, '项目id不能为空');
return ctx.body = yapi.commons.resReturn(null, 400, '项目id不能为空');
}
if (!params.col_id) {
return ctx.body = yapi.commons.resReturn(null, 400, '项目id不能为空');
return ctx.body = yapi.commons.resReturn(null, 400, '接口集id不能为空');
}
if (!params.env) {
return ctx.body = yapi.commons.resReturn(null, 400, '缺少环境配置');
}
if (!params.path) {
return ctx.body = yapi.commons.resReturn(null, 400, 'path 不能为空');
}
if(!params.casename){
return ctx.body = yapi.commons.resReturn(null, 400, '用例名称不能为空');
return ctx.body = yapi.commons.resReturn(null, 400, '用例名称不能为空');
}
params.uid = this.getUid();
@ -181,7 +179,7 @@ class interfaceColController extends baseController{
params.add_time = yapi.commons.time();
params.up_time = yapi.commons.time();
let result = await this.caseModel.save(params);
ctx.body = yapi.commons.resReturn(result);
}catch(e){
@ -196,8 +194,8 @@ class interfaceColController extends baseController{
* @category col
* @foldnumber 10
* @param {String} caseid
* @returns {Object}
* @example
* @returns {Object}
* @example
*/
async getCase(ctx){
@ -218,8 +216,8 @@ class interfaceColController extends baseController{
* @foldnumber 10
* @param {String} name
* @param {String} desc
* @returns {Object}
* @example
* @returns {Object}
* @example
*/
async upCol(ctx){
@ -243,8 +241,8 @@ class interfaceColController extends baseController{
* @category col
* @foldnumber 10
* @param {Array} [id, index]
* @returns {Object}
* @example
* @returns {Object}
* @example
*/
async upCaseIndex(ctx){
@ -259,9 +257,9 @@ class interfaceColController extends baseController{
yapi.commons.log(err.message, 'error')
})
}
})
return ctx.body = yapi.commons.resReturn('success')
}catch(e){
ctx.body = yapi.commons.resReturn(null, 400, e.message)
@ -274,9 +272,9 @@ class interfaceColController extends baseController{
* @method GET
* @category col
* @foldnumber 10
* @param {String}
* @returns {Object}
* @example
* @param {String}
* @returns {Object}
* @example
*/
async delCol(ctx){
@ -304,8 +302,8 @@ class interfaceColController extends baseController{
}
/**
*
* @param {*} ctx
*
* @param {*} ctx
*/
async delCase(ctx){
@ -336,6 +334,7 @@ class interfaceColController extends baseController{
}
module.exports = interfaceColController
</pre>
</div>
</div>

52
static/doc/static/server/controllers/project.js.html vendored
View File

@ -72,8 +72,6 @@ class projectController extends baseController {
* @foldnumber 10
* @param {String} name 项目名称，不能为空
* @param {String} basepath 项目基本路径，不能为空
* @param {String} prd_host 项目线上域名，不能为空。可通过配置的域名访问到mock数据
* @param {String} protocol 线上域名协议，不能为空
* @param {Number} group_id 项目分组id，不能为空
* @param {String} project_type private public
* @param {String} [desc] 项目描述
@ -85,8 +83,6 @@ class projectController extends baseController {
params = yapi.commons.handleParams(params, {
name: 'string',
basepath: 'string',
prd_host: 'string',
protocol: 'string',
group_id: 'number',
desc: 'string'
});
@ -109,35 +105,16 @@ class projectController extends baseController {
return ctx.body = yapi.commons.resReturn(null, 401, '已存在的项目名');
}
if (!params.prd_host) {
return ctx.body = yapi.commons.resReturn(null, 400, '项目domain不能为空');
}
params.basepath = params.basepath || '';
if ((params.basepath = this.handleBasepath(params.basepath)) === false) {
return ctx.body = yapi.commons.resReturn(null, 401, 'basepath格式有误');
}
if (!this.verifyDomain(params.prd_host)) {
return ctx.body = yapi.commons.resReturn(null, 401, '线上域名格式有误');
}
let checkRepeatDomain = await this.Model.checkDomainRepeat(params.prd_host, params.basepath);
if (checkRepeatDomain > 0) {
return ctx.body = yapi.commons.resReturn(null, 401, '已存在domain和basepath');
}
let data = {
name: params.name,
desc: params.desc,
prd_host: params.prd_host,
basepath: params.basepath,
protocol: params.protocol || 'http',
members: [],
project_type: params.project_type || 'private',
uid: this.getUid(),
@ -322,6 +299,9 @@ class projectController extends baseController {
}
try {
let result = await this.Model.get(params.id);
result = result.toObject();
delete result.members;
result.role = await this.getProjectRole(params.id, 'project');
ctx.body = yapi.commons.resReturn(result);
} catch (e) {
ctx.body = yapi.commons.resReturn(null, 402, e.message);
@ -361,8 +341,7 @@ class projectController extends baseController {
_users[item._id] = item;
});
ctx.body = yapi.commons.resReturn({
list: result,
userinfo: _users
list: result
});
} catch (e) {
ctx.body = yapi.commons.resReturn(null, 402, e.message);
@ -453,7 +432,6 @@ class projectController extends baseController {
* @param {Number} id 项目id，不能为空
* @param {String} name 项目名称，不能为空
* @param {String} basepath 项目基本路径，不能为空
* @param {String} prd_host 项目线上域名，不能为空。可通过配置的域名访问到mock数据
* @param {String} [desc] 项目描述
* @param {Array} [env] 项目环境配置
* @param {String} [env[].name] 环境名称
@ -470,8 +448,6 @@ class projectController extends baseController {
params = yapi.commons.handleParams(params, {
name: 'string',
basepath: 'string',
prd_host: 'string',
protocol: 'string',
group_id: 'number',
desc: 'string'
});
@ -489,17 +465,9 @@ class projectController extends baseController {
return ctx.body = yapi.commons.resReturn(null, 401, 'basepath格式有误');
}
if (!this.verifyDomain(params.prd_host)) {
return ctx.body = yapi.commons.resReturn(null, 401, '线上域名格式有误');
}
if (projectData.name === params.name) {
delete params.name;
}
if (projectData.basepath === params.basepath && projectData.prd_host === params.prd_host) {
delete params.basepath;
delete params.prd_host;
}
if (params.name) {
let checkRepeat = await this.Model.checkNameRepeat(params.name);
@ -508,24 +476,15 @@ class projectController extends baseController {
}
}
if (params.basepath && params.prd_host) {
let checkRepeatDomain = await this.Model.checkDomainRepeat(params.prd_host, params.basepath);
if (checkRepeatDomain > 0) {
return ctx.body = yapi.commons.resReturn(null, 401, '已存在domain和basepath');
}
}
let data = {
up_time: yapi.commons.time()
};
if (params.name) data.name = params.name;
if (params.desc) data.desc = params.desc;
if (params.prd_host ) {
data.prd_host = params.prd_host;
if (params.basepath ) {
data.basepath = params.basepath;
}
if (params.protocol) data.protocol = params.protocol;
if (params.env) data.env = params.env;
let result = await this.Model.up(id, data);
@ -577,7 +536,6 @@ class projectController extends baseController {
'members',
{ key: 'group_id', alias: 'groupId' },
{ key: 'up_time', alias: 'upTime' },
{ key: 'prd_host', alias: 'prdHost' },
{ key: 'add_time', alias: 'addTime' }
];
let groupRules = [