nodejs

昂首阔步 (What is Swagger)

Swagger is the largest framework for designing APIs using a common language with including documentation, design, testing, and deployment. Swagger easily comprehensible for both developers and non-developers. Thus, software developers, product and project managers, business analysts, etc can access API design. Also, as Swagger is easily adjustable, it can be successfully used for API testing and bug fixing.

Swagger是使用通用语言(包括文档,设计,测试和部署)来设计API的最大框架。 Swagger对于开发人员和非开发人员都很容易理解。 因此,软件开发人员,产品和项目经理,业务分析师等可以访问API设计。 另外,由于Swagger易于调整,因此可以成功地用于API测试和错误修复。

There are 2 packages are used for integrating swagger with APIs in nodejs:

有2个用于将swagger与API集成到nodejs中的软件包:

  • swagger-jsdoc

    swagger-jsdoc

  • swagger-ui-express

    swagger-ui-express

用法 (Usage)

Install using npm:

使用npm安装:

npm i swagger-jsdoc swagger-ui-express

after that define routes in the main file called server.js and integrate swagger code for per API.

之后,在名为server.js的主文件中定义路由,并为每个API集成swagger代码。

To check the swagger API documentation

查看swagger API文档

  1. Run the server:运行服务器:

npm run start

npm运行开始

2. Open chrome and past server IP address like:

2.打开chrome和过去的服务器IP地址,例如:

http://localhost:3000/api-docs/

http:// localhost:3000 / api-docs /

It looks like

看起来像

Yeah! We successfully integrated Swagger

nodejs_昂首阔步的nodejs相关推荐

  1. react和nodejs_如何使用NodeJS和React为SaaS构建Stripe Billing入门流程

    react和nodejs 你会学什么? (What will you learn?) In this article we will be going over the steps needed to ...

  2. hibernate框架构建_我们如何构建服务框架而不是框架

    hibernate框架构建 目录 (Table of Contents) Introduction介绍 Building the Skeleton 建立骨架 - HTTP Endpoints -HTT ...

  3. java web nodejs_我的2013--从java web到nodejs

    2013年,从一名纯搞java web的程序员到了nodejs. 以前,一直在做java web企业级应用,做过不少,到了下半年9月份,我被调到了一个美国研究所的项目,用的是nodejs/mongod ...

  4. 2万人同时访问 nodejs_面向前端工程师的Nodejs入门手册(一)

    前言 本文面向的读者已经是了解JavaScript基本使用的前端程序员,但是缺乏服务端的经验,接下来将带你走进在服务端的世界,看看运行在服务端的JavaScript是如何工作的,它与运行在浏览器端的J ...

  5. mac 安装nodejs_阿里开源——用于前端和nodejs的轻量级任务管理和构建工具Dawn

    介绍 Dawn 取「黎明.破晓」之意,原为「阿里云·业务运营团队」内部的前端构建和工程化工具,现已完全开源.它通过 pipeline 和 middleware 将开发过程抽象为相对固定的阶段和有限的操 ...

  6. react和nodejs_如何使用React,TypeScript,NodeJS和MongoDB构建Todo应用

    react和nodejs In this tutorial, we will be using TypeScript on both sides (server and client) to buil ...

  7. orm mysql nodejs_【译】Nodejs最好的ORM

    TypeORM是一个采用TypeScript编写的用于Node.js的优秀ORM框架,支持使用TypeScript或Javascript(ES5, ES6, ES7)开发. 目标是保持支持最新的Jav ...

  8. CentOS6安装nodejs

    Nodejs是JavaScript的一种运行环境,是一个服务端的JavaScript解释器. NPM是Nodejs的包管理器. Nodejs包含npm,所以安装完nodejs后npm默认也被安装. 安 ...

  9. 让我们一起认识一下Nodejs

    Nodejs Nodejs是一个运行在chrome Javascript运行环境下(俗称GoogleV8引擎)的开发平台,用来方便快捷的创建服务器端网络应用程序.可以把它理解为一个轻量级的JSP或PH ...

最新文章

  1. 【Spring】银行转账案例
  2. [手机分享]黑莓手机7系列分享之——黑莓7730
  3. Tomcat服务在Eclipse中能够正常启动,但页面出现404错误的解决方法
  4. Servlet 工作原理解析--转载
  5. 视觉SLAM学习--RGB-D SLAM学习(待完善)
  6. 蓝桥杯 ALGO-11 算法训练 瓷砖铺放
  7. centos7安装openjdk8
  8. 算法移植优化(七)cmake常用函数记录
  9. mac下electron始终安装不成功解决办法
  10. 学习笔记之dns正反向解析区域,主从服务,子域授权,安全
  11. php数据表创建命令代码,MySQL创建和删除数据表的命令及语法详解
  12. MATLAB 绘图函数及绘图辅助
  13. Appium原理及使用
  14. spss分析qpcr数据_手把手教你使用 SPSS 分析实时荧光定量数据
  15. 中控考勤机数据通过java程序读取方法
  16. __raw_writel, writel_relaxed 和 writel的区别
  17. 驾驶员疲劳监测系统DMS
  18. pca 累积方差贡献率公式_SPSS主成分分析时,是不是得到的方差百分比就是贡献率,累计百分比就是累计贡献率??...
  19. 计算机清除服务命令,快速清理电脑垃圾用什么命令
  20. 微信小说域名被封-366tool在线解答微信屏蔽小说网页停止访问的解决方案

热门文章

  1. Win10系统电脑关机时提示“内存不能为read”的解决方法
  2. 福利图网站的正确使用姿势
  3. UI设计一般要学多久,学完有多少工资呢?
  4. 数据恢复顾问(DRA)
  5. 转-龙符-146-宝鸣儿
  6. 58同城秋招笔试题解答 --map模式按value进行排序
  7. 程序员必看!2021最新京东Java面试题目附详细答案解析
  8. SimSwap 高保真人脸交换的高效框架 以及 deepfake辨别图片或者视频真假 dalle-mini文字生成图片
  9. Android中TextView文字设置不同的颜色
  10. Java黑马程序员:文字版格斗游戏