5 Star 7 Fork 4

ChinaLym / shoulder-framework

 / 详情

完善 api-doc 部分

Done
owner
Opened this issue  
2020-05-26 01:14

采用 swagger2(open-api2)

Why not swagger3(open-api3)?

  • 太新了,很多周边不支持
  • 绝大多数开发者更熟悉 swagger2

Comments (3)

ChinaLym created任务
ChinaLym set related repository to ChinaLym/shoulder-framework
ChinaLym set assignee to ChinaLym
ChinaLym added
 
feature
label
ChinaLym set priority to Main
ChinaLym added
 
delay
label
ChinaLym changed priority from Main to Unimportant
展开全部操作日志

接口文档可视化的做法

  • swagger-ui/knife4j系列(常见)
    • 单体服务,需要这部分配置(少)
    • 界面一般仅在网关访问,只需在网关配置一次(常见)
  • 根据swagger注解生成json/markdown/自定义解析(少)
  • idea插件生成json同步到api-doc-ui服务(yApi、RAP 2、eolinker等),这样的工具一堆堆(常见)

由于接口文档可视化方式、工具繁多,因此提供sawagger默认配置的优先级较低,后续再考虑提供

springfox 现在已经支持 OpenAPI3,故编码技术选型选择主流的 swagger,并考虑使用 knife4j 优化界面。
使用者也可以考虑使用 start-doc 避免 swagger 的代码入侵(避免意义可能没那么大)。
另推荐 yapi 作为 api 管理平台,而非默认的 ui 界面或 knife4j。【shoulder-ipaas 中将提供 docker 镜像】

shoulder 提供 api 默认配置,但不应再封装一遍如何配置(由于 api 本身就是定制的东西),大部分使用者会自行配置默认的 docket,shoulder 提供的即可默认失效。

能力将在 0.6 版本中提供。

ChinaLym removed
 
delay
label
ChinaLym changed branch from dev to master
ChinaLym changed issue state from 待办的 to 已完成

Sign in to comment

状态
Assignees
Milestones
Pull Requests
关联的 Pull Requests 被合并后可能会关闭此 issue
Branches
Planed to start   -   Planed to end
-
Top level
Priority
参与者(1)
Java
1
https://gitee.com/ChinaLym/shoulder-framework.git
git@gitee.com:ChinaLym/shoulder-framework.git
ChinaLym
shoulder-framework
shoulder-framework

Search