CentOS 7 搭建swagger Api文档管理系统

1，系统环境

a，操作系统 CentOS Linux release 7.6.1810 (Core) 64位

b，安装Node.js的npm工具环境：

# Node 官网已经把 linux 下载版本更改为已编译好的版本了，我们可以直接下载解压后使用：
wget https://nodejs.org/dist/v10.9.0/node-v10.9.0-linux-x64.tar.xz    # 下载
tar xf  node-v10.9.0-linux-x64.tar.xz       # 解压
cd node-v10.9.0-linux-x64/                  # 进入解压目录
./bin/node -v                               # 执行node命令 查看版本
# 创建软链接做环境变量
ln -s /usr/software/nodejs/bin/npm   /usr/local/bin/
ln -s /usr/software/nodejs/bin/node   /usr/local/bin/

最后安装完成，输入命令 “node -v”，得到正确的版本号

2，下载swagger代码

git clone https://github.com/swagger-api/swagger-ui   # 克隆swagger前端界面代码
git clone https://github.com/swagger-api/swagger-editor # 克隆swagger后端代码

耐心下载，两个文件都是240M左右

3，启动swagger-editor部署

npm install -g http-server  # npm安装node.js  htpp服务器
cd swagger-editor/   # 打开swagger后端目录
http-server -p 8000  # 启动node.js服务器，端口8000

访问：http://ip地址:8000/

4，启动swagger-ui部署

cd ..                # 返回上层目录
mkdir swagger        # 创建 swagger目录
cd swagger           # 打开 swagger目录
touch package.json   # 创建 打包文件
npm init package.json              # npm初始化，一路回车就好

npm install express --save  # npm安装express
mkdir public                    # 创建public目录
cp -r ../swagger-ui/dist/ public/ # 拷贝swagger-ui/dist到public目录
touch index.js    # 创建index.js
vi index.js       # 编辑 index.js 内容如下
########################################################
var express = require('express');
var http = require('http');
var app = express();
app.use('/static', express.static('public'));
app.listen(8005, function () {console.log('app listening on port 8005!');
});
########################################################
node index.js    # 启动index.js

访问： http://ip地址:8005/static/dist/index.html

CentOS 7 搭建swagger Api文档管理系统相关推荐

CentOS 7 搭建RAP2r Api文档管理系统
1,系统环境 a,操作系统 CentOS Linux release 7.6.1810 (Core) 64位 2,安装npm环境: # Node 官网已经把 linux 下载版本更改为已编译好的 ...
python api文档管理工具_开源的api文档管理系统
在项目中,需要协同开发,所以会写许多API文档给其他同事,以前都是写一个简单的TXT文本或Word文档,口口相传,这种方式比较老土了,所以,需要有个api管理系统专门来管理这些api,从网上找了许多比 ...
swagger api文档_带有Swagger的Spring Rest API –创建文档
swagger api文档使REST API易于使用的真正关键是好的文档. 但是,即使您的文档做得很好,您也需要设置公司流程的权利以正确,及时地发布它. 确保利益相关者按时收到是一回事,但是您也要负 ...
swagger api文档_带有Swagger的Spring Rest API –公开文档
swagger api文档创建API文档后,将其提供给涉众很重要. 在理想情况下,此发布的文档将足够灵活以解决任何最后的更改,并且易于分发(就成本以及完成此操作所需的时间而言). 为了使之成为可能, ...
swagger 扫描java文档_推荐一款在运行时通过javadoc生成Swagger API文档的库
介绍一般,我们使用Springfox生成swagger api文档,但Springfox不支持从javadoc中生成,只能通过注解的方式标注文档. 这样,当共享一些POJO类时,为了同时生成java ...
聚合微服务中的 Swagger API 文档
没有做 API 文档聚合,访问每个服务的 API 文档都需要访问单独的 swagger-ui.html 页面,既然我们使用了微服务,就应该有统一的 API 文档入口,而 knife4j 有这方面的支持 ...
Oh my God, Swagger API文档竟然可以这样写？
最好的总会在不经意间出现. " 作为后端程序员,免不了与前端同事对接API, 一个书写良好的API设计文档可有效提高与前端对接的效率. 为避免联调时来回撕逼,今天我们聊一聊正确编写Swaag ...
Showdoc 搭建项目 API 文档系统
showdoc 是 PHP 开发的一款 api 文档系统,因此所需环境和普通 PHP 项目一致准备环境: php nginx composer //注意更换国内镜像,否则速度会很慢,甚至失败创建项 ...
SpringBoot 显示Swagger Api 文档
1. 配置pom文件,在pom文件中引入Swagger的相关依赖:  <dependency><groupId>com.githu ...

CentOS 7 搭建swagger Api文档管理系统

CentOS 7 搭建swagger Api文档管理系统相关推荐

最新文章

热门文章