首页 > 其他分享 >yapi文档使用说明记录

yapi文档使用说明记录

时间:2023-04-01 14:37:52浏览次数:56  
标签:记录 yapi 接口 文档 泛型 上传 Settings

  1. yapi文档地址:http://192.168.0.97:3000/

   

 

 

  1. 在idea下载插件:easy-yapi

 

 

  1. 配置插件

 

在 Settings->Other Settings -> EasyAPI 中的 **server **栏中填写服务器地址:http://yapi.gwm.cn/

在 Settings->Other Settings -> EasyAPI 的 **tokens **中填写项目 token。一个项目对应一个 token。这步可以跳过。没有填写时后面上传会提醒填写。

 

 

 

 

 

 

Token在yapi对应的项目里面:以community为例:

 

 

 

 

  1. 上传接口使用

 

接口写完后,在 Controller 类中单击右键:点击 **ExportToYapi 或者 Export **都可以上传接口。

推荐使用 Export 方式上传。Export 可以选择上传哪些接口。ExportToYapi 会把类里的接口都上传,如果 Yapi 中有过编辑更改的话,会被覆盖调。

 

 

 

 

 

导出成功截图

 

 

 

6. 注意事项

给接口添加注释

Yapi 是通过扫描类来获取接口的信息生成文档,所以如果添加一定的注释会更有利于文档的生成,减少后续的编辑操作。
下面两个接口一个有注释,一个没有,生成的文档会不一样。

  

 

 

 

 

 

2.参数的备注

一般如果是单个参数,直接在类上面自定义注释即可。

 

 

 

 

如果的dto类型的入参和返回参数,使用

/**

 * 备注

* @mock,可选,如果有其他信息

*/

 

 

 

 

 

3.使用泛型

项目中的 Result 是支持泛型的,编写接口时把泛型指定上,这样 Yapi 才能识别出返回数据的类型去扫描获取信息。

·        public class Result<T>

 

 

 

 

 

 

如上,如果不指定类型,返回数据会是data.解决方式就是Result<T>泛型里面加上具体的类型。

3.如果需要全量导入,直接在对应的controller进行全量导入:

·        

 

 

参考:https://blog.csdn.net/weixin_42183401/article/details/127497342

标签:记录,yapi,接口,文档,泛型,上传,Settings
From: https://www.cnblogs.com/thinkingandworkinghard/p/17278566.html

相关文章

  • 记录使用uniapp出现Not found -1,68,0[ERROR]的问题
    由于组件代码内容很长,就对代码进行了拆分,把index.vue里面的template和css代码放到了index.vue里面,把js代码放到了index.js里面,结果h5上面没有问题,app调试的时候出现了Notfound-1,68,0[ERROR]。找到原因是把components也写到了mixin里面,需要把组件引入的代码写在index.vue里面......
  • DDR知识记录
      DDR的读写都是64字节为单位的:开ECC的时候,小于64BYTE写的话,就需要读出来补齐到64BYTE,然后计算ECC校验值,再写入ECC校验区的8BYTE,再写入数据区的64BYTE;不开ECCDDR可以maskwrite,开ECC只能发RMW 【Read-Modify-Write】  https://zhuanlan.zhihu.com/p/586977359Mask......
  • 【LBLD】刷题记录
    【LBLD】刷题记录labuladong的算法小抄第零章、核心框架汇总学习算法和刷题的思维框架我的刷题心得【LBLD】双指针技巧秒杀七道链表题目【LBLD】双指针技巧秒杀七道数组题目第一章、手把手刷数据结构手把手刷链表算法【LBLD】双指针技巧秒杀七道链表题目【LBLD】递归......
  • 自动生成接口文档coreapi的使用
    1.安装coreapi  2.路由中配置路由固定格式   3.视图类自动生成接口文档第一种_单一方法的视图   4.第二种_包含多个方法的视图_在类视图的文档字符串中_分开方法定义   5.生成接口文档的setting和路由配置   5_1.生成接口文档的setting......
  • 项目一众筹网05_02_[树形开发]菜单管理、API文档发布到web服务器、配置文件里面修改to
    系列文章目录文章目录系列文章目录08-页面显示树形结构-前端-使用真实数据09-准备zTree的API文档(因为现在没有图标)==API文档发布到web服务器上去==配置文件里面修改tomcat的默认端口号(只需改动3个地方)10-前端-显示图标-分析思路(-页面显示树形结构)11-前端-显示图标-代码实现(-页面......
  • mongodb--文档查询
    一、简单查询--查询所有文档db.COLLECTION_NAME.find()--将查询结果以json形式显示db.COLLECTION_NAME.find().pretty()二、按条件查询文档db.COLLECTION_NAME.find(query,projection)参数说明:query:可选,projection:可选,查询时返回文档中所有键值,(默认省略)说明:按条件......
  • 前端工程化实践 - 多人开发分支管理、Git记录提交规范(二)
    一、前言Git在工作中是很重要的一部分,如果操作不熟练或者使用不规范,很容易给工作造成很多麻烦比如习惯所有功能写在一个分支,导致无法分开上线比如提交了依赖目录,导致Git仓库的代码过大比如合并分支出现错误,将不用上线的代码提交比如分支命名不规范,导致误删分支这一篇正好是前端工程......
  • mongodb-文档的插入、更新与删除操作
    一、文档的插入--单文档插入db.COLLECTION_NAME.insert(document)db.COLLECTION_NAME.insertOne(document)--insert也可以插入多文档db.COLLECTION_NAME.save(document)--insert与save区别--insert方法插入若文档中已存在该文档,会报错,反之写入--save方法插入若集合中已......
  • day3 函数的定义和调用,练习编写简单的程序(记录3)
    0331.h#ifndef_0331_H#define_0331_H/********************************************************************文件名称:0331.h*功能描述:函数的定义和调用的头文件*创建作者:wenjie*创建日期:2023/03/31*************************************************************......
  • day3 函数的定义和调用,练习编写简单的程序(记录1)
    一、函数的定义可以分为以下两种:1、函数声明和函数定义分离这种方法将函数声明和函数定义分开,通常在头文件中先声明函数原型,然后在源文件中实现函数定义。例如,头文件example.h中声明了一个函数add:#ifndefEXAMPLE_H#defineEXAMPLE_Hintadd(inta,intb);//声明函......