# vue-doc

**Repository Path**: clattanoia/vue-doc

## Basic Information

- **Project Name**: vue-doc
- **Description**: 基于js 的 api文档，可以在线请求接口，只需2步即可写好接口文档。轻量，方便，快捷
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2017-03-27
- **Last Updated**: 2020-12-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ShuangRen-doc
基于js 的 api文档，可以在线请求接口，只需2步即可写好接口文档。轻量，方便，快捷
<div class="in_wrap">
    <h2 class="page-header">打包配置</h2>
    <p>1.安装nodejs</p>
    <p>2.执行npm install</p>
    <p>3.执行npm run build</p>
    <p>4.打开build文件夹下的index.html</p>
    <p>4.在线demo：<a href="http://api.webzeal.cn">http://api.webzeal.cn</a></p>
</div>

<div class="in_wrap in_wrap2">
    <h2 class="page-header">使用手册</h2>
    <p>1.config／config.code.js 用于书写错误码，按规则填写即可</p>
    <p>2.config／config.api.js 用于遍历，每个接口对应一个 key->value  比如 userlist：用户列表， 按示范填写即可</p>
    <p>3.api／api.xx.js 则是接口文档，注意xx对应上一步的 config.api.js中的 key ，需要一致，比如userlist ，这里文件名则为api.userlist.js</p>
    <p>4.api／api.xx.js参数说明：title：接口地址，name：中文名，methods：请求方式，req：请求参数，res：返回参数</p>
    <p>5.config／config.main.js 配置文件，参数有：domain：接口域名， public：每个接口公共的参数，如index.php，没有可不填， headers：请求头，没有可不填</p>
    <p>6.关于js请求跨域解决：1.使用proxy服务器代理，2.接口的header 里 增加Access-Control-Allow-Origin:＊， 3.配置chorme参数实现允许跨域访问</p>
</div>