Swagger Editor 的部署使用

文章目录

    • 一、swagger 本地部署
      • 1、安装 nodejs、npm
      • 2、npm 安装 http server
      • 3、下载项目
      • 4、环境变量
      • 5、运行hs服务
    • 二、Swagger 使用
    • 三、关于

一、swagger 本地部署

Swagger Editor 可以使用在线编辑器,也可以离线本地部署环境。使用YAML定义接口规范,接口文档生成不同框架服务端、客户端。可以导出JSON格式API规范,通过Swagger UI发布。

1、安装 nodejs、npm

npmNodejs的包管理器

戳node.js官网

戳node.js文档

image-20210626234415416

2、npm 安装 http server

npm install -g http-server

image-20210622225505619

..\npm\下生成http-serverhs

..\npm\node_modules下生成http-server

image-20210622230329669

3、下载项目

Swagger-Editor GitHub项目
image-20210623010502769

4、环境变量

拷贝hs.cmd的绝对路径C:\Users\Administrator\AppData\Roaming\npm(npm安装hs的目录)作为HS_HOME环境变量
image-20210623005724216

5、运行hs服务

命令行 cdSwagger-Editor 项目下载存放目录,运行命令 hs ,默认端口8080;也可指定端口 hs -p 8081Ctrl+C 可以停止服务运行

image-20210623011908585

二、Swagger 使用

  • 建议使用Firefox/Google Chrome访问 http://127.0.0.1:8080 image-20210623012700439

  • YAML格式字段,附:yaml语法

    swagger: '2.0'                      # swagger版本
    info:
      title: 文档标题
      description:  描述
      version: "v1.0"                   # 版本号
      termsOfService: ""                # 服务截止日期
      contact:                          # 联系
        name: ""                        # 姓名
        url: ""                         # URL
        email: ""                       # 邮箱
      license:                          # 授权证书
        name: ""                        # 名称,如Apache 2.0
        url: ""                         # URL
    host: api.xxx.net                   # 域名,可包含端口,默认提供yaml文件的host
    basePath: /                         # 前缀
    schemes:                            # 传输协议
      - http
      - https
    
    securityDefinitions:                # 安全设置
      api_key:
        type: apiKey
        name: Authorization             # 实际变量名,如Authorization
        in: header                      # 变量放哪里,query或header
      OauthSecurity:                    # oauth2
        type: oauth2
        flow: accessCode                # 可选implicit/password/application/accessCode
        authorizationUrl: 'https://oauth.simple.api/authorization'
        tokenUrl: 'https://oauth.simple.api/token'
        scopes:
          admin: Admin scope
          user: User scope
          media: Media scope
      auth:
        type: oauth2
        description: ""                 # 描述
        authorizationUrl: http://haofly.net/api/oauth/
        name: Authorization             # 实际变量名,如Authorization
        tokenUrl:
        flow: implicit                  # 认证形式,implicit/password/application/accessCode
        scopes:
          write:post: 修改文件
          read:post: 读取文章
    
    security:                           # 全局安全设置
      auth:
        - write:pets
        - read:pets
    
    consumes:                           # 接收MIME types列表
      - application/json                # 接收响应Content-Type
      - application/vnd.github.v3+json
    
    produces:                           # 请求MIME types列表
      - application/vnd.knight.v1+json  # 请求头Accept值
      - text/plain; charset=utf-8
    tags:
      - name: post
        description: 关于post的接口
    
    externalDocs:
      description: find more info here
      url: https://haofly.net
    
    paths:                              # 接口url详细信息
      /projects/{projectName}:          # 接口后缀,可定义参数
        get:
          tags:                         # 所属分类的列表
            - post  
          summary: 接口描述              # 简介
          description:                  # 描述
          externalDocs:
            description:
            url:
          operationId: ""               # 操作唯一ID
          consumes: [string]            # 可接收的mime type列表
          produces: [string]            # 可发送的mime type列表
          schemes: [string]             # 可接收的协议列表
          deprecated: false             # 接口是否已经弃用
          security:                     # OAuth2认证
            - auth: 
                - write:post
                - read: read
          parameters:                   # 接口参数
            - name: projectName         # 参数名
              in: path                  # 参数在哪个地方,如path、body、query等
              type: string              # 参数类型
              allowEmptyValue: boolean  # 是否允许空值
              description: 项目名        # 参数描述
              required: true            # 是否必须
              default: *                # 设置默认值
              maximum: number           # number最大值
              exclusiveMaximum: boolean # 是否排除最大的值
              minimum: number           # number最小值
              exclusiveMinimum: boolean
              maxLength: integer        # int最大值
              minLength: integer
              enum: [*]                 # 枚举值
              items:                    # type为数组时可定义其项目类型
            - $ref: "#/parameters/uuidParam"
          responses:                    # 设置响应
            200:                        # 通过http状态描述响应
              description: Success      # 响应描述
              schema:                   # 返回数据的结构
                $ref: '#/definitions/ProjectDataResponse'  # 关联至某个model
    
      /another: # 另一个接口
          responses:
            200:
                description:
                schema:
                  type: object
                  properitis:
                    data:
                        $ref: '#/definitions/User' # 关联
    
    definitions:            # Model/Response的定义
      Product:              # 定义一个model
        type: object        # model类型
        properties:         # 字段列表
          product_id:       # 字段名
            type: integer   # 字段类型
            description:    # 字段描述
          product_name:
            type: string
            description: 
      ProjectDataResponse:
        type: object
        properties:
            data:
                $ref: '#/definitions/ProjectResponse'  # model之间关联,表示data字段里包含的是一个ProjectResponse对象
    parameters:             # 接口使用的params
      limitParam:
        name: limit
        in: query
        description: max records to return
        required: true
        type: integer
        format: int32
    responses:              # 接口使用的responses
      NotFound:
        description: Entity not found.
    

三、关于

博主CSDN@崔同学原创码字不易,喜欢记得点赞收藏支持哦 😃

热门文章

暂无图片
编程学习 ·

那些年让我们目瞪口呆的bug

程序员一生与bug奋战,可谓是杀敌无数,见怪不怪了!在某知识社交平台中,一个“有哪些让程序员目瞪口呆的bug”的话题引来了6700多万的阅读,可见程序员们对一个话题的敏感度有多高。 1、麻省理工“只能发500英里的邮件” …
暂无图片
编程学习 ·

redis的下载与安装

下载redis wget http://download.redis.io/releases/redis-5.0.0.tar.gz解压redis tar -zxvf redis-5.0.0.tar.gz编译 make安装 make install快链方便进入redis ln -s redis-5.0.0 redis
暂无图片
编程学习 ·

《大话数据结构》第三章学习笔记--线性表(一)

线性表的定义 线性表:零个或多个数据元素的有限序列。 线性表元素的个数n定义为线性表的长度。n为0时,为空表。 在比较复杂的线性表中,一个数据元素可以由若干个数据项组成。 线性表的存储结构 顺序存储结构 可以用C语言中的一维数组来…
暂无图片
编程学习 ·

对象的扩展

文章目录对象的扩展属性的简洁表示法属性名表达式方法的name属性属性的可枚举性和遍历可枚举性属性的遍历super关键字对象的扩展运算符解构赋值扩展运算符AggregateError错误对象对象的扩展 属性的简洁表示法 const foo bar; const baz {foo}; baz // {foo: "bar"…
暂无图片
编程学习 ·

让程序员最头疼的5种编程语言

世界上的编程语言,按照其应用领域,可以粗略地分成三类。 有的语言是多面手,在很多不同的领域都能派上用场。大家学过的编程语言很多都属于这一类,比如说 C,Java, Python。 有的语言专注于某一特定的领域&…
暂无图片
编程学习 ·

写论文注意事项

参考链接 给研究生修改了一篇论文后,该985博导几近崩溃…… 重点分析 摘要与结论几乎重合 这一条是我见过研究生论文中最常出现的事情,很多情况下,他们论文中摘要部分与结论部分重复率超过70%。对于摘要而言,首先要用一小句话引…
暂无图片
编程学习 ·

安卓 串口开发

上图: 上码: 在APP grable添加 // 串口 需要配合在项目build.gradle中的repositories添加 maven {url "https://jitpack.io" }implementation com.github.licheedev.Android-SerialPort-API:serialport:1.0.1implementation com.jakewhart…
暂无图片
编程学习 ·

2021-2027年中国铪市场调研与发展趋势分析报告

2021-2027年中国铪市场调研与发展趋势分析报告 本报告研究中国市场铪的生产、消费及进出口情况,重点关注在中国市场扮演重要角色的全球及本土铪生产商,呈现这些厂商在中国市场的铪销量、收入、价格、毛利率、市场份额等关键指标。此外,针对…
暂无图片
编程学习 ·

Aggressive cows题目翻译

描述&#xff1a; Farmer John has built a new long barn, with N (2 < N < 100,000) stalls.&#xff08;John农民已经新建了一个长畜棚带有N&#xff08;2<N<100000&#xff09;个牛棚&#xff09; The stalls are located along a straight line at positions…
暂无图片
编程学习 ·

剖析组建PMO的6个大坑︱PMO深度实践

随着事业环境因素的不断纷繁演进&#xff0c;项目时代正在悄悄来临。设立项目经理转岗、要求PMP等项目管理证书已是基操&#xff0c;越来越多的组织开始组建PMO团队&#xff0c;大有曾经公司纷纷建造中台的气质&#xff08;当然两者的本质并不相同&#xff0c;只是说明这个趋势…
暂无图片
编程学习 ·

Flowable入门系列文章118 - 进程实例 07

1、获取流程实例的变量 GET运行时/进程实例/ {processInstanceId} /变量/ {变量名} 表1.获取流程实例的变量 - URL参数 参数需要值描述processInstanceId是串将流程实例的id添加到变量中。变量名是串要获取的变量的名称。 表2.获取流程实例的变量 - 响应代码 响应码描述200指…
暂无图片
编程学习 ·

微信每天自动给女[男]朋友发早安和土味情话

微信通知&#xff0c;每天给女朋友发早安、情话、诗句、天气信息等~ 前言 之前逛GitHub的时候发现了一个自动签到的小工具&#xff0c;b站、掘金等都可以&#xff0c;我看了下源码发现也是很简洁&#xff0c;也尝试用了一下&#xff0c;配置也都很简单&#xff0c;主要是他有一…
暂无图片
编程学习 ·

C语言二分查找详解

二分查找是一种知名度很高的查找算法&#xff0c;在对有序数列进行查找时效率远高于传统的顺序查找。 下面这张动图对比了二者的效率差距。 二分查找的基本思想就是通过把目标数和当前数列的中间数进行比较&#xff0c;从而确定目标数是在中间数的左边还是右边&#xff0c;将查…
暂无图片
编程学习 ·

项目经理,你有什么优势吗?

大侠被一个问题问住了&#xff1a;你和别人比&#xff0c;你的优势是什么呢? 大侠听到这个问题后&#xff0c;脱口而出道&#xff1a;“项目管理能力和经验啊。” 听者抬头看了一下大侠&#xff0c;显然听者对大侠的这个回答不是很满意&#xff0c;但也没有继续追问。 大侠回家…
暂无图片
编程学习 ·

nginx的负载均衡和故障转移

#注&#xff1a;proxy_temp_path和proxy_cache_path指定的路径必须在同一分区 proxy_temp_path /data0/proxy_temp_dir; #设置Web缓存区名称为cache_one&#xff0c;内存缓存空间大小为200MB&#xff0c;1天没有被访问的内容自动清除&#xff0c;硬盘缓存空间大小为30GB。 pro…
暂无图片
编程学习 ·

业务逻辑漏洞

身份认证安全 绕过身份认证的几种方法 暴力破解 测试方法∶在没有验证码限制或者一次验证码可以多次使用的地方&#xff0c;可以分为以下几种情况︰ (1)爆破用户名。当输入的用户名不存在时&#xff0c;会显示请输入正确用户名&#xff0c;或者用户名不存在 (2)已知用户名。…