当前位置:网站首页>Swagger UI tutorial API document artifact
Swagger UI tutorial API document artifact
2022-07-06 20:56:00 【51CTO】
Catalog
[TOC]
Preface
In some interface projects ,API Is used frequently , So a API Online document generation and testing tools are essential . and Swagger UI It's such a practical online tool
This blog describes how to follow the Swagger UI, Note that the company's test server is Linux Systematic , Therefore, this blog only introduces based on Linux Systematic Swagger Environment building process
Server environment installation ##
NodeJS Download deployment ###
First you need to download NodeJS, To nodejs Official website http://nodejs.org/dist/v0.10.26, download node-v0.10.26-linux-x64.tar.gz, Because this is already compiled , So we first use software to upload files to Linux The server , have access to WinSCP
And then use Linux Of cd The command comes to you nodejs Location of compressed files
The decompression command is as follows :
And then go to the file
perform
Set up node overall situation
Set up npm overall situation
testing nodejs and npm Is the installation successful
You can see the version number , What installation succeeded
express Download deployment ####
Install well NodeJS and NPM after , We can install it express 了
The following important modules are needed with express The frame is installed together :
body-parser - node.js middleware , Used for processing JSON, Raw, Text and URL Encoded data .
cookie-parser - This is an analysis Cookie Tools for . adopt req.cookies You can take it from cookie, And turn them into objects .
multer - node.js middleware , Used for processing enctype="multipart/form-data"( Set the MIME code ) Form data for .
Check whether the installation is successful
NodeJS Boot up ####
Then set the NodeJS Boot up
install forever
Set up
Swagger UI Installation and deployment ##
github On clone: https://github.com/swagger-api/swagger-ui If there is a download Git, Just use git download , Get access to github, Direct download
Then, according to the needs of the company , stay Linux On mkdir, I was there first root route , Create a node_app file
Get into node_app
Environment configuration
The following tips can be filled in according to your own needs
VI Editor use :
Add code
Enable server
visit , Input http:// Company servers IP:3000
You can see Helloworld, Of course, we need to deploy Swagger
stay node_app So let's create one public Folder
Then download to swagger ui Inside dist Copy the files in the folder to public Folder
modify index.js
Then input http://ip:3000/swapper, Yes, you can see something similar page
Picture description here
Swagger Editor Use ##
Swagger Editor yes Swagger UI The online editor , We can build our own , You can also use the official , The official URL: http://editor.swagger.io/#/
github On Clone: https://github.com/swagger-api/swagger-editor After the swagger editor Put the document in the company Linux Server
Http server install ###
Start the project http-server swagger-editor, The default is 8080 port
Set up port And start the swagger editor
Input http://ip:2017/#/ You can access your own Swagger Editor Editor
Reference tutorial
http://www.linuxidc.com/Linux/2014-07/104489.htm
http://www.linuxidc.com/Linux/2014-06/103372.htm
边栏推荐
- Why do novices often fail to answer questions in the programming community, and even get ridiculed?
- Use of OLED screen
- R語言可視化兩個以上的分類(類別)變量之間的關系、使用vcd包中的Mosaic函數創建馬賽克圖( Mosaic plots)、分別可視化兩個、三個、四個分類變量的關系的馬賽克圖
- 【mysql】触发器
- 正则表达式收集
- ##无yum源安装spug监控
- @PathVariable
- [asp.net core] set the format of Web API response data -- formatfilter feature
- 数据湖(八):Iceberg数据存储格式
- 硬件开发笔记(十): 硬件开发基本流程,制作一个USB转RS232的模块(九):创建CH340G/MAX232封装库sop-16并关联原理图元器件
猜你喜欢
2022 refrigeration and air conditioning equipment installation and repair examination contents and new version of refrigeration and air conditioning equipment installation and repair examination quest
OAI 5g nr+usrp b210 installation and construction
Core principles of video games
[weekly pit] calculate the sum of primes within 100 + [answer] output triangle
Common doubts about the introduction of APS by enterprises
"Penalty kick" games
OAI 5G NR+USRP B210安装搭建
Boder radius has four values, and boder radius exceeds four values
Laravel笔记-自定义登录中新增登录5次失败锁账户功能(提高系统安全性)
2022 construction electrician (special type of construction work) free test questions and construction electrician (special type of construction work) certificate examination
随机推荐
知识图谱之实体对齐二
Rhcsa Road
Intel 48 core new Xeon run point exposure: unexpected results against AMD zen3 in 3D cache
c#使用oracle存储过程获取结果集实例
Implementation of packaging video into MP4 format and storing it in TF Card
7、数据权限注解
Recyclerview GridLayout bisects the middle blank area
Introduction to the use of SAP Fiori application index tool and SAP Fiori tools
How to upgrade high value-added links in the textile and clothing industry? APS to help
Function optimization and arrow function of ES6
OLED屏幕的使用
use. Net analysis Net talent challenge participation
Trends of "software" in robotics Engineering
防火墙基础之外网服务器区部署和双机热备
Event center parameter transfer, peer component value transfer method, brother component value transfer
Yyds dry goods count re comb this of arrow function
Pinduoduo lost the lawsuit, and the case of bargain price difference of 0.9% was sentenced; Wechat internal test, the same mobile phone number can register two account functions; 2022 fields Awards an
过程化sql在定义变量上与c语言中的变量定义有什么区别
[weekly pit] positive integer factorization prime factor + [solution] calculate the sum of prime numbers within 100
Kubernetes learning summary (20) -- what is the relationship between kubernetes and microservices and containers?