Swagger2 配置说明

Swagger2 简介

1. 随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了：前端渲染、先后端分离的形态，而且前端技术和后端技术在各自的道路上越走越远。
2. 前端和后端的唯一联系，变成了API接口；API文档变成了前后端开发人员联系的纽带，变得越来越重要，swagger就是一款让你更好的书写API文档的框架。

项目配置

1. 在每个yaml配置文件中会存在

################################################################################################################  
###接口文档（Swagger UI）配置：  
################################################################################################################
swagger:
  enabled: true
  authorization:
    key-name: X-Authorization
  title: 微服务开发台 - 认证授权（管理功能）
  description: 该模块完成组织机构管理、角色用户管理、功能菜单按钮管理
  version: ${application.version:1.0.0-SNAPSHOT}
  contact:
    name: xxxx
    url: http://xxx.com
  base-package: com.xxx
  base-path:
    - /**
  exclude-path:
    - /error
    - /ops/**
  # 公共参数
  global-operation-parameters:
    - name: X-Authorization
      description: JWT鉴权
      modelRef: string
      parameterType: header
      # 公共参数写成requierd, 对于不需要登录的接口随便写一个字符串即可
      required: true
  # 通用返回错误码
  apply-default-response-messages: true

其中需要修改的参数包括title、description

2. 在每个子服务的启动类上添加 @EnableSwagger2Doc 启用Swagger2