/vue-online-document

在线文档的前端模板

Primary LanguageVueMIT LicenseMIT

vue-online-document

在线文档的前端模板

模板基本上复用https://gitee.com/leihenshang/api-doc-php

轻量化的api接口文档工具

install package

yarn or yarn install

run

yarn serve or npm run serve

build

yarn build

package image

yarn config set sass_binary_site http://cdn.npm.taobao.org/dist/node-sass -g yarn config set registry https://registry.npm.taobao.org -g

look config

yarn config get registry

示例

API详情

功能列表

  • Auth
    • 登录 /api/auth/login
    • 登录会员信息 /api/auth/me
  • 项目内的权限验证
  • 分组管理
    • 列表 /api/groups
    • 创建 /api/group/create
    • 编辑 /api/group/update
    • 批量更新分组排序与归属父级 /api/group/batch-save
    • 支持拖动分组与排序
  • 项目管理
    • 列表 /api/projects
    • 详情 /api/project/detail
    • 创建 /api/project/create
    • 编辑 /api/project/update
    • 删除 /api/project/delete
  • API管理
    • 列表 /api/apis
    • 详情 /api/api/detail
    • 创建 /api/api/create
    • 编辑 /api/api/update
    • 删除 /api/api/delete
  • 文档管理
    • 列表 /api/docs
    • 详情 /api/doc/detail
    • 创建 /api/doc/create
    • 编辑 /api/doc/update
    • 删除 /api/doc/delete
  • 字段映射
    • 列表 /api/field-mappings
    • 详情
    • 创建 /api/field-mapping/create
    • 编辑 /api/field-mapping/update
    • 删除 /api/field-mapping/delete
  • 项目成员
    • 列表 /api/project-members
    • 详情
    • 创建 /api/project-member/create
    • 编辑 /api/project-member/update
    • 删除 /api/project-member/delete
    • 设置权限 /api/project-member/set-role-power
    • 设置成员的管理员权限 /api/project-member/set-leader
  • 操作日志
    • 列表 /api/operation-logs