接口文档问题总结

最新推荐文章于 2022-05-31 10:58:04 发布
最新推荐文章于 2022-05-31 10:58:04 发布
阅读量159 收藏
点赞数
分类专栏： 隔日年终反思 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/hlw521hxq/article/details/107929298
版权

接口文档问题总结：

  • 输出参数对象值哟啊列举
  • 接口名称 主标题 副标题 命名没有驼峰命名
  • 接口字段使用容易引起歧义字段
  • 接口命名没有读懂核心业务
  • 跳转链接不是JumpLink，跳转分为linkurl，linkpage，linkapp等多种，命名不规范
天才梦浪
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
swagger导出接口文档
王魂风气的博客
04-20 3万+
最近工作上需要用Swagger导出接口文档 经过查找资料总结了一下： Swagger简介 1、是一款让你更好的书写API文档的规范且完整框架。 2、提供描述、生产、消费和可视化RESTful Web Service。 3、是由庞大工具集合支撑的形式化规范。这个集合涵盖了从终端用户接口、底层代码库到商业API管理的方方面面。 简单来说，Swagger是一个帮助开发人员编写接口文档的工具，它可以帮你自...
后端接口文档例子 word
03-18
"后端接口文档详解" 在本文档中，我们将详细介绍后端接口文档的编写，特别是Java接口文档的编写。通过本文档，我们将了解后端接口文档的重要性、编写格式、请求参数、返回参数等方面的知识点。 一、为什么需要后端...
接口文档相关问题
君莫笑
11-01 2161
接口文档相关内容
接口文档修改问题分析
无
05-31 491
问题价值： 1.在实际中，经常出现接口本身的增删改查，参数的修改和添加删除，返回值的变化和修改； 2.前后端分离，接口文档是一种非常重要的前后端人员沟通的媒介 ，但是接口文档又具有版本时效性的特点； 3.公司人员的流入流出，新人对项目接口的理解需要借助尽可能的接口文档，特别是对参数的description, 不然一种领域的系统，可能因为对领域参数的不了解，造成对效率的影响 技术选型分析： 1.swagger 的问题就是注解太多，导致项目代码耦合了太多接口文档相关代码，但是和springboot适配性好 2.
接口开发，写接口文档时遇到的问题
sonexp的博客
12-07 1005
1.编写json格式数据时，{"id":1},正确的格式是使用双引号，不能使用单引号
小驼峰大驼峰的写法
热门推荐
。。。的博客
01-15 4万+
编程中关于小驼峰大驼峰也有一套规范，比如有一个变量为：myfirstname 小驼峰命名规则：第一个单词小写，其他单词首字母大写 写法如：myFirstName 大驼峰命名规则：第一个单词大写，其他单词首字母也大写 写法如：MyFirstName ...
接口用例设计与常见接口问题汇总
测试龙巫师的博客
06-07 1993
一、接口用例设计 一、接口测试用例可以从功能、性能、安全三方面进行入手，设计。 详情参看以下思维导图： 二、接口常见问题汇总 一、接口技术层面 1、输入参数验证校验不全面。如： 1.1入参数据类型长度边界，范围边界。 1.2 入参数据内容、成员内容，有效无效，合法非法。 1.3 入参数据 特殊字符 敏感字符过滤。 1.4 入参可否必选。 2、接口内部触发的服务相关逻辑问题。如： 2.1 接口约束条件不够...
java快速生成接口文档方法总结
congge
07-27 1万+
前言 常常在项目收尾阶段，客户需要项目的接口文档，或者是一个大的sass平台，各个产品之间互相调用的时候，需要对方提供接口文档 通常来说，接口文档属于产品的技术沉淀，是一个长期积累的过程，然而，很多时候，开发阶段并不会想的那么多，结果到了需要接口文档的时候总是疲于应付，情急之下，往往采用最笨拙的办法，就是对照着项目代码，一个个拷贝吧 下面针对这个情况，小编这里给出2种简单、快捷而适用的解决方案，帮助你快速解决这个烦恼吧 方案一，使用japidocs 这是一种最简单也最高效的快速生成接口文档的方式，也是对既有
Swagger离线接口文档生成总结
凉水的博客
08-24 1万+
Swagger离线接口文档生成总结 前言 需求：项目使用spring boot，maven工程，需要使用swagger生成接口文档，格式为html。 在网上查了一些资料，大部分是使用swagger-ui，在线文档，不符合要求；小部分提到了离线文档生成，但是总觉得有点绕，结合实际的使用经验，输出总结一篇，供参考。 本文使用常见的生成流程，swagger json -> asciid...
接口文档与接口文档管理工具
m0_51660523的博客
07-14 1万+
1.接口文档的定义：在项目开发汇总，web项目的前后端是分离开发的。应用程序的开发，需要由前后端工程师共同定义接口，编写接口文档，之后大家都根据这个接口文档进行开发，到项目结束前都要一直维护。 2.接口文档的功能与目的： （1）项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发 （2）项目维护中或者项目人员更迭的时候，方便后期人员查看、维护 3.接口文档规范： 首先了解一下接口，接口分为四部分：请求方法、url、请求参数、返回参数： （1）方法：常用的方法就是下面的四种：GET PUT PO
ArkimeAPI接口文档
最新发布
04-24
### Arkime API 接口文档概述 #### 一、引言 Arkime是一款强大的网络流量分析工具，提供了丰富的API接口供开发者使用。本篇旨在详细解读Arkime API接口文档的关键内容，帮助用户更好地理解并利用这些接口进行数据...
存储设备接口技术文档汇总
07-22
教程名称： 存储设备接口技术文档汇总【】XP下USB接口转RS232设备驱动【】云存储数据管理接口规范【】存储接口技术之串行ATA和SAS解析【】存储硬盘接口ATASATASCSISASFC比较【】技术论文：SATA-高性能和主流台式PC...
1.接口文档_接口文档_
09-29
总结，接口文档是软件开发中不可或缺的一部分，尤其在MySQL这样的数据库管理系统中，接口文档可以帮助开发者有效地使用和集成数据库服务。在mac系统上安装MySQL 8.0.22时，一份详尽的接口文档将极大地提升工作效率和...
restful接口文档模板
12-10
### RESTful接口文档模板知识点解析 #### 一、RESTful接口概述 REST（Representational State Transfer）是一种网络应用程序的设计风格和开发方式，基于HTTP协议，可以使用XML或者JSON格式传输数据，一般用于...
json异常显示{"$ref":"$[0]"},{"$ref":"$[0]"}]
hlw521hxq的博客
03-01 5520
同事的代码里面出现了不一样的json，数据插入都是成功的，为甚用fastjson一解析就错误了！ 然后我分析了他的代码，然后模拟了它的出错信息！ 结果如下： 数组打印：[User(name=李白, age=20), User(name=李白, age=20), User(name=李白, age=20)] json打印：[{"age":"20","name":"李白"},{"$ref":".
使用office365邮箱的时候 O365: 451 5.7.3 STARTTLS is required to send mail
hlw521hxq的博客
09-24 3196
使用的是Hutool-mail的依赖 使用自定义参数配置，参数如下，然后就发送成功了，具体原因下次再分析吧！ 如果是使用其他依赖，依旧可以使用以下的指定参数，依旧正常 推荐使用common-mail这个组件。 MailAccount mailAccount = new MailAccount(); mailAccount.setHost(host); mailAccount.setPort(port); mailAccount.setFrom(from)
Base64图片转换后，一直获取不到结果
hlw521hxq的博客
12-24 1884
自己写的ByteArrayInputStream转换结果，然后失败了。气急败坏下用了HuTool工具ImgUtil.toImage，哎，咋提示<font color=red>Image type is not supported!</font> 结论：图片base64字符串都有一个前缀data:image/png;base64，去掉后处理就正常了。 String result = base64.substring(base64.indexOf(",")+1); ...
本地发送http请求the trustAnchors parameter must be non-empty
hlw521hxq的博客
06-03 1345
the trustAnchors parameter must be non-empty 背景 ：之前封装的http请求工具类，请求第三方，一直提示没有凭证。 解决方案：后来，才发现原来是服务器的jdk版本是OpenJdk，最后切换成SE jdk1.8.0_45后，启动，发送请求，Objk！ 哈哈 ...
dubbo 接口文档
04-17
Dubbo是一种高性能的Java RPC框架，用于...总结一下，Dubbo并没有特定的接口文档规范，接口文档的编写通常是根据实际需求和开发团队的规范来完成的。开发人员可以使用JavaDoc注释和第三方工具来编写和生成接口文档。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值