基于NodeJS + Swagger UI搭建Web API界面

基于NodeJS + Swagger UI搭建Web API界面

  • 前言
  • 一、创建基于NodeJS的Swagger运行目录
  • 二、添加Swagger官方的示例
    • 1.创建public工作目录
    • 2.添加Swagger官方示例
    • 3.启动SwaggerUI实例
  • 三、基于OpenAPI规范提供api文档


前言

Swagger是一个REST APIs文档在线自动生成和测试的框架

一、创建基于NodeJS的Swagger运行目录

> mkdir node-swagger
> cd node-swagger
# 初始化node项目
> npm init
# 基于express框架构建
# -S或--save:将包保存为生产依赖,添加到dependencies字段
# -D或--save-dev:将包保存为开发依赖,添加到devDependencies字段
> npm install express -S

二、添加Swagger官方的示例

1.创建public工作目录

> mkdir public

2.添加Swagger官方示例

(1)获取示例

# 下载示例
> git clone  https://github.com/swagger-api/swagger-ui.git

(2)将dist目录下的所有文件拷贝到/public目录下

3.启动SwaggerUI实例

(1)NodeJS脚本
node-swagger目录下创建index.js文件,内容:

const path = require('path');
const express = require('express');
const app = express();app.use('/static', express.static(path.join(__dirname, 'public')));
app.listen(3000, () => console.log('hello~'));

打开/public/swagger-initializer.js并修改

window.onload = function() {//<editor-fold desc="Changeable Configuration Block">// the following lines will be replaced by docker/configurator, when it runs in a docker-containerwindow.ui = SwaggerUIBundle({url: "https://petstore.swagger.io/v2/swagger.json",dom_id: '#swagger-ui',deepLinking: true,presets: [SwaggerUIBundle.presets.apis,SwaggerUIStandalonePreset],plugins: [SwaggerUIBundle.plugins.DownloadUrl],layout: "StandaloneLayout"});//</editor-fold>
};

修改为

window.onload = function() {//<editor-fold desc="Changeable Configuration Block">// the following lines will be replaced by docker/configurator, when it runs in a docker-containerwindow.ui = SwaggerUIBundle({// url: "https://petstore.swagger.io/v2/swagger.json",url:"./app/lvmei-openapi.yaml",dom_id: '#swagger-ui',deepLinking: true,presets: [SwaggerUIBundle.presets.apis,SwaggerUIStandalonePreset],plugins: [SwaggerUIBundle.plugins.DownloadUrl],layout: "StandaloneLayout"});//</editor-fold>
};

以后就可以替换./app/lvmei-openapi.yaml来迭代更新接口文档

(2)启动脚本

> node index.js

node index.js启动会阻塞命令行
使用pm2,采用守护进程模式运行

# 安装npm
> sudo npm install pm2 -g -unsafe-perm
# 启动
> pm2 start index.js
# pm2管理的守护进程清单
> pm2 list
# pm2停止所管理的守护进程
> pm2 stop app-id

启动后,可以通过以下地址访问:
http://localhost:3000/static/index.html

三、基于OpenAPI规范提供api文档

打开https://editor.swagger.io/可以打开模版文档
基于模板文档即可修改定制的api文档:

1.将模板文档内容复制到vscode
2.vscode安装扩展《OpenAPI (Swagger) Editor》
3.定制api文档即可

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/bicheng/3230.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Linux下的基本指令(1)

嗨喽大家好呀&#xff01;今天阿鑫给大家带来Linux下的基本指令&#xff08;1&#xff09;&#xff0c;下面让我们一起进入Linux的学习吧&#xff01; Linux下的基本指令 ls 指令pwd命令cd 指令touch指令mkdir指令(重要)rmdir指令 && rm 指令(重要)man指令(重要)cp指…

基于 NXP iMX8MM 测试 Secure Boot 功能

By Toradex秦海 1). 简介 嵌入式设备对于网络安全的要求越来越高&#xff0c;而 Secure boot就是其中重要的一部分。 NXP i.MX8MM/i.MX8MP 处理器基于 HABv4 特性来提供 Secure boot 启动过程中的 Chain of Trust&#xff1b; HABv4 是基于公共密钥加密 (Public Key Cryptogr…

C语言进阶:指针的进阶(上)

首先 在学习新知识之前 我们先来回顾下之前的学习的内容 1 指针是个变量 用来存放地址 地址唯一标识的一块内存空间 2 指针的大小是固定的4/8字节&#xff08;32位平台/64位平台&#xff09; 3 指针有类型的 指针的类型决定了两点 一个是指针操作的权限以及整数的步长 4 指针的…

神经网络项目:全连接网络和卷积网络实现水果三分类项目

水果三分类项目 Git源码&#xff1a;传送门 水果种类&#xff1a;草莓、树莓、桑葚 0&#xff1a;草莓 strawberry1&#xff1a;树莓 raspberry2&#xff1a;桑葚 mulberry 项目设计 获取数据 spider.py数据清洗 cleaner.py自定义数据集 dataset.py网络构建 net.py训练模型 t…

2024年新版宝塔面板如何安装WordPress网站教程

使用宝塔面板安装WordPress教程 一、准备工作 安装了宝塔面板后&#xff0c;我们就可以开始搭建自己的网站了。以安装WordPress为例&#xff0c;本文将详细介绍两种安装方式&#xff1a;手动安装和宝塔后台一键部署。请注意&#xff0c;尽管一键部署方便快捷&#xff0c;但可…

git工具简单使用

文章目录 git上传克隆README.gitignore常用指令冲突 git 进行版本控制的版本控制器。安装git yum install -y git 配置git git config --global user.email "youexample.com" 告诉git你的邮箱是什么&#xff1f;最好输入你的gitee的注册邮箱git config --global …

人工智能(pytorch)搭建模型28-基于Transformer的端到端目标检测DETR模型的实际应用,DETR的原理与结构

大家好&#xff0c;我是微学AI&#xff0c;今天给大家介绍一下人工智能(pytorch)搭建模型28-基于Transformer的端到端目标检测DETR模型的实际应用&#xff0c;DETR的原理与结构。DETR&#xff08;Detected Transformers&#xff09;是一种基于Transformer的端到端目标检测模型&…

利用tree-sitter提取代码文件中的函数和注释

利用tree-sitter提取代码文件中的函数和注释 1. 需求2. 工具3. 实现 1. 需求 提取.c或.cpp文件中的带有注释的函数&#xff0c;作为训练数据喂给大语言模型。要求是能够批量处理&#xff0c;提取函数前带有注释的函数和注释&#xff0c;并将函数中的注释同样提取出来作为辅助训…

把 KubeBlocks 跑在 Kata 上,真的可行吗?

背景 容器的安全性一直是广受关注的话题。这个领域也产生了很多不错的开源项目。Kata就是其中之一。 Kata Containers&#xff08;简称 Kata&#xff09;是一种开源项目&#xff0c;它提供了一种安全而高性能的容器运行时环境。Kata Containers 利用虚拟化技术&#xff08;通常…

【算法刷题 | 贪心算法03】4.25(最大子数组和、买卖股票的最佳时机|| )

文章目录 4.最大子数组和4.1题目4.2解法一&#xff1a;暴力4.2.1暴力思路4.2.2代码实现 4.3解法二&#xff1a;贪心4.3.1贪心思路4.3.2代码实现 5.买卖股票的最佳时机||5.1题目5.2解法&#xff1a;贪心5.2.1贪心思路5.2.2代码实现 4.最大子数组和 4.1题目 给你一个整数数组 n…

【面经八股】搜广推方向:面试记录(十三)

【面经&八股】搜广推方向:面试记录(十三) 文章目录 【面经&八股】搜广推方向:面试记录(十三)1. 自我介绍2. 实习经历问答3. 八股之类的问题4. 编程题5. 反问6. 可以1. 自我介绍 。。。。。。 2. 实习经历问答 挑最熟的一个跟他讲就好了。 一定要熟~3. 八股之类…

Mac下XDebug安装

文章目录 1、下载对应的版本2、编译XDebug3、配置XDebug4、配置PhpStormDebug一下 前置工作 Mac下安装HomebrewMac下brew安装php7.4 1、下载对应的版本 首先按照支持的版本和兼容性来下载对应的版本&#xff0c;此表列出了仍支持哪些 Xdebug 版本&#xff0c;以及哪些版本可用…

GPT的全面历史和演变:从GPT-1到GPT-4

人工智能新篇章&#xff1a;GPT-4与人类互动的未来&#xff01; 本文探讨了生成式预训练 Transformer (GPT) 的显着演变&#xff0c;提供了从开创性的 GPT-1 到复杂的 GPT-4 的旅程。 每次迭代都标志着重大的技术飞跃&#xff0c;深刻影响人工智能领域以及我们与技术的互动。 我…

linux+ndk把jni制作成so库供apk使用(基础)

环境配置之类的我之前的博客有写,这篇文章我们就直接开始 1.在有ndk配置的服务器创建文件夹,文件夹再创建jni文件夹,jni文件夹里面放置Application.mk,Android.mk与test.c,因为我的ndk运行配置默认是项目下面的jni目录,所以我需要多一个jni目录 2.这里的Application.mk写的是架…

OpenHarmony语言基础类库【@ohos.util (util工具函数)】

ohos.util (util工具函数) 该模块主要提供常用的工具函数&#xff0c;实现字符串编解码&#xff08;[TextEncoder])&#xff0c;[TextDecoder]&#xff09;、有理数运算&#xff08;[RationalNumber8]&#xff09;、缓冲区管理&#xff08;[LRUCache9]&#xff09;、范围判断&…

5款好用的监控员工电脑软件推荐 (如何监控员工上班工作情况)

在现代的商业环境中&#xff0c;管理和监控员工的工作内容是至关重要的。 为了确保员工的工作效率和质量&#xff0c;公司需要使用一些工具来监控他们的工作进程。 以下是五款实用的监控员工工作内容的软件。 域智盾软件 域智盾是一款专为企业打造的智能管理系统。 它借助人…

Vivado-IP-DDS and Testbench Learning

DDS内部结构 实现流程 首先新建一个工程&#xff0c;创建bd文件&#xff0c;添加DDS Compiler核&#xff0c;此处不多赘述 Block Design 在观测输出的信号时&#xff0c;需要将最高位符号位的信号取反&#xff0c;这样才能输出正弦波&#xff0c;否则输出的波形如下图所示 将t…

暴雨亮相CCBN2024 助力广电行业数智化转型

4月23日&#xff0c;第三十届中国国际广播电视信息网络展览会&#xff08;简称CCBN2024&#xff09;在北京开展&#xff0c;本次展览会由国家广播电视总局指导、广播电视科学研究院主办&#xff0c;作为国内广电视听领域首个综合性、专业化、引领性、国际化科技产业盛会&#x…

第三节课,后端登录【1】

一、总任务 二、登录接口 get 请求&#xff0c;有缺陷&#xff0c;长度有限制 三、登录逻辑 四、代码书写位置 4.1 编写业务逻辑的位置 五、写代码 5.1 代码1 5.1.1 细节 按 CtrlAltShiftL ,快速格式化 5.1. 2 自动生成接口参数 先/** 再回车 效果图 5.2 按 alt enter …

ffmpeg与sdl的个人笔记

说明 这里的ffmpeg基础知识和sdl基础知识仅提及与示例代码相关的知识点, 进阶可学习雷神的博客。 https://blog.csdn.net/leixiaohua1020 当然&#xff0c;如代码写的有问题或有更好的见解&#xff0c;欢迎指正&#xff01; 音视频基础知识 在学习音视频理论知识时&#xff…