README_CN.md

Share API

介绍

基于Swagger，Swagger open api 2.0 规范，通过配置Swagger JSON 生成API 文档。

功能与特性

更友好的界面

更直观的展示

支持 enum的展示

支持公开，私有 不同的展示

支持配置私有API文档 ip访问白名单

支持私有化搭建

版本 1.1.0

1. 支持二级路径

• 有些场合下需要使用 www.example.com/scopePath 来访问，而不是直接通过域名 www.example.com 访问
• 现在scopePath 是一个可配置的项

2. 重写了setting 相关代码，表单验证全部由 antd 接管

3. 新增 enablePrivate 配置，默认关闭，开启后会启用私有接口和非私有接口的区分

• 通过开关开控制私有配置的开关，部分场景并不需要私有配置
• 之前的设计导致使用过于复杂，在没有配置IP白名单的情况下，需要输入密码才能访问配置项

更多更新日志

快速开始

提供2种方式启动

从 npm 安装

1. 下载 npm 包

npm i @shuangren/share-api
yarn add @shuangren/share-api

2. 新建 js 文件并引入

// index.js
const ApiDoc = require('@shuangren/share-api');
const doc = new ApiDoc();
doc.start();

3. 启动

node index.js

从 git 安装

1. clone 仓库

git clone https://github.com/ShuangRen/share-api.git

2. 安装依赖

npm install
yarn

3. 启动

node dist/server/start.js

扩展配置

npm 安装

// index.js
const ApiDoc = require('@shuangren/share-api');
const doc = new ApiDoc();
doc.config({
  port: '3001',
  password: 'abc123',
  dataPath: '/var/demo/data.config'
});
doc.start();

git clone 安装

直接修改 dist/server/config 文件里的配置

配置说明

dataPath 缓存接口配置列表的数据文件， 默认在 dist/server 目录下

password 切换到内部访问时的密码，默认 123456

port 启动端口，默认 8081

ipList 运行直接内部访问的ip 列表，默认 []

scopePath 启用后，使用 www.example.com/scopePath 访问, 默认 空字符串, 需要开启 proxy-pass 反代shareapi-static 到 node 服务地址。

enablePrivate 开启私有配置功能, 默认 false

``

全量配置参考

doc.config({
  port: '3001',
  password: 'abc123',
  dataPath: '/var/demo/data.config'
  ipList:[
    '192.168.1.111',
    '21.221.1.111'
  ],
  scopePath = 'abc',
  enablePrivate = true
});