当前位置:网站首页>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
边栏推荐
- Entity alignment two of knowledge map
- 监控界的最强王者,没有之一!
- 使用.Net分析.Net达人挑战赛参与情况
- #yyds干货盘点#重新梳理箭头函数的this
- Web开发小妙招:巧用ThreadLocal规避层层传值
- What is the difference between procedural SQL and C language in defining variables
- 看过很多教程,却依然写不好一个程序,怎么破?
- 逻辑是个好东西
- (工作记录)2020年3月11日至2021年3月15日
- R语言可视化两个以上的分类(类别)变量之间的关系、使用vcd包中的Mosaic函数创建马赛克图( Mosaic plots)、分别可视化两个、三个、四个分类变量的关系的马赛克图
猜你喜欢
Hardware development notes (10): basic process of hardware development, making a USB to RS232 module (9): create ch340g/max232 package library sop-16 and associate principle primitive devices
【OpenCV 例程200篇】220.对图像进行马赛克处理
Utilisation de l'écran OLED
The mail command is used in combination with the pipeline command statement
[diy] self designed Microsoft makecode arcade, official open source software and hardware
看过很多教程,却依然写不好一个程序,怎么破?
1500万员工轻松管理,云原生数据库GaussDB让HR办公更高效
【mysql】游标的基本使用
Redis insert data garbled solution
Pycharm remote execution
随机推荐
面试官:Redis中有序集合的内部实现方式是什么?
The most comprehensive new database in the whole network, multidimensional table platform inventory note, flowus, airtable, seatable, Vig table Vika, flying Book Multidimensional table, heipayun, Zhix
New database, multidimensional table platform inventory note, flowus, airtable, seatable, Vig table Vika, Feishu multidimensional table, heipayun, Zhixin information, YuQue
Dynamically switch data sources
Value of APS application in food industry
[200 opencv routines] 220 Mosaic the image
Redis insert data garbled solution
Application layer of tcp/ip protocol cluster
R語言可視化兩個以上的分類(類別)變量之間的關系、使用vcd包中的Mosaic函數創建馬賽克圖( Mosaic plots)、分別可視化兩個、三個、四個分類變量的關系的馬賽克圖
全网最全的新型数据库、多维表格平台盘点 Notion、FlowUs、Airtable、SeaTable、维格表 Vika、飞书多维表格、黑帕云、织信 Informat、语雀
【mysql】游标的基本使用
I've seen many tutorials, but I still can't write a program well. How can I break it?
In line elements are transformed into block level elements, and display transformation and implicit transformation
Mtcnn face detection
华为设备命令
【DSP】【第一篇】开始DSP学习
硬件开发笔记(十): 硬件开发基本流程,制作一个USB转RS232的模块(九):创建CH340G/MAX232封装库sop-16并关联原理图元器件
PG basics -- Logical Structure Management (transaction)
Intel 48 core new Xeon run point exposure: unexpected results against AMD zen3 in 3D cache
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