OpenApi文档生成 ​

已经内置自动支持。swagger文档。和最新的OpenApi3 文档。项目启动后即可访问。

1. swagger-ui.html 文档。路径/swagger-ui.html

2. 基于spring-doc 文档UI增强 路径/doc.html

3. 接口文档属性信息

openapi:
    description:
    title:
    version:
    license: 
    contact:
      name:
      email:
      url:

• 启动项目后，访问 http://server:port/context-path/swagger-ui.html 即可进入 Swagger UI 页面，OpenAPI 描述将在以下 json 格式的 url 中 提供：http://server:port/context-path/v3/api-docs
• server：域名 或 IP
• port：服务器端口
• context-path：应用程序的上下文路径，springboot 默认为空
• 文档也可以 yaml 格式提供，位于以下路径：/v3/api-docs.yaml

如果嫌弃官方提供的 swagger-ui 不美观，或者使用不顺手，可以选择关闭 ui，还可以剔除掉 ui 相关的 webjar 的引入。

springdoc:
  swagger-ui:
    enabled: false

OpenAPI 文档信息，默认可在此 url 中获取： http://server:port/context-path/v3/api-docs。 可以利用其他支持 OpenAPI 协议的工具，通过此地址，进行 API 展示，如 Apifox。 （ Postman 的 api 测试也可以利用此地址进行导入生成 ）

Knife4j (原 swagger-bootstrap-ui) 3.x 版本提供了对于 OpenAPI 协议的部分支持。

由于 knife4j 对于规范支持的不全面，无法直接使用单文档源数据，所以必须进行分组或者 urls 的指定。

# urls
springdoc:
  swagger-ui:
    urls:
      - { name: 'sample', url: '/v3/api-docs' }

或者

#分组
springdoc:
  group-configs:
    - { group: 'sample', packages-to-scan: 'com.example' }

Knife4j 的 UI 访问地址有所不同，页面映射在 doc.html 路径下，启动项目后，访问 http://server:port/context-path/doc.html

即可进入 Knife4j 的 Swagger UI 页面。