如何将swagger导出为优雅的doc或者pdf文档

最新推荐文章于 2024-08-09 10:02:55 发布

晨曦雨落

最新推荐文章于 2024-08-09 10:02:55 发布

阅读量8.5k

点赞数 1

分类专栏：技术工具 spring

本文链接：https://blog.csdn.net/weixin_43748936/article/details/111841739

版权

如何将swagger json导出为优雅的doc或者pdf文档

所需要的工具：
第一步:
第二步：
第三步：

#需求：项目完成后领导要求出一个后端的接口文档，文档要求：输入参数（请求参数），输出参数（响应参数）要清晰明了，即不管是输入参数还是输出参数都要有参数说明。然后输入输出参数要和实际保持一致。要的效果如下：

这是预计输入参数：

{
   
  "courseId": "string",
  "createTime": "2020-12-28T03:57:40.232Z",
  "delFlag": "string",
  "matchRate": 0,
  "recId": "string",
  "updateTime": "2020-12-28T03:57:40.232Z",
  "userId": "string"
}

这是实际输入参数（有些参数是不需要传的，这个在详细的接口文档中会有说明）：

{
   
  "courseId": "164165161",
  "matchRate": 0,
  "recId": "1614651561165615",
  "userId": "1616511651"
}

这是预计响应参数：

{
   
  "code": 0,
  "data": {
   
    "current": 0,
    "hitCount": true,
    "pages": 0,
    "records": [
      {
   
        "accountType": "string",
        "avatarUrl": "string",
        "createTime": "2020-12-28T03:51:42.782Z",
        "delFlag":