如何写接口文档

原创 已于 2023-08-02 11:54:43 修改 · 91 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#前端 #java

于 2023-08-02 11:50:34 首次发布
本文讲述了使用PostJson离线工具时遇到的小问题，即在发送JSON请求时，需要确保Content-Type头设置正确。工具处理请求后能生成Markdown文档，但需手动组装并生成返回结果表格。

用了 PostJson工具

http://coolaf.com/doc/index

使用时候有个小bug

选json后

还是要在header 里面 改为  Content-Type:application/json，不然请求不正常

的离线工具，请求后点击里面生成文档，再修改一个markdown就可以,生成出的是一个一个的，最后再组装一下，也会自动生成返回结果的表格

wangiyeng
关注
《Java接口文档自动生成：5个魔法让你甩掉手写文档！》
java专栏
04-08 1951
通过这5个魔法，你的Java接口文档从“过期报纸”变成了“智能机器人”，自动化工具就像“文档管家”，让每次代码提交都自动更新文档，再也不怕“文档和代码打架”！：用SpringDoc和Swagger，像“翻译官”一样把代码翻译成文档。：用Git和CI/CD，像“时间胶囊”一样保存每个版本的文档。：接口改了N次，但文档还是旧的，像“过期的报纸”。：每次改代码都要改文档，像“重复劳动的机器人”。：文档在仓库里没人看，像“无人问津的宝藏”。：文档和代码不一致，像“说谎的镜子”。🔥关注墨瑾轩，带你探索编程的奥秘！
常用在线测试工具(postJson)
weixin_44975322的博客
10-16 8995
http://coolaf.com/ （常用在线测试工具）
一款强大的Qt HTTP POST JSON请求工具推荐
gitblog_09766的博客
10-15 965
一款强大的Qt HTTP POST JSON请求工具推荐 去发现同类优质开源项目:https://gitcode.com/ 项目介绍 在日常的开发工作中，HTTP请求的测试和调试是不可或缺的一部分。为了简化这一过程，我们推荐一款由Qt实现的HTTP POST JSON请求工具。该工具不仅支持通过HTTP POST方法发送请求，还能自动处理JSON数据的上传和中文字符的UTF-8编码转换，极大地提高...
Java网络请求工具类Get请求/Post请求/Json数据的请求
dongyan3595的博客
02-26 1057
package cn.com.baidu.util; import cn.com.tenlion.util.smc.SMCHttpUtil; import javax.net.ssl.*; import java.io.BufferedReader; import java.io.InputStreamReader; import java.io.OutputStream; import java.io.PrintWriter; import java.net.HttpURLConnection; im.
ApiPost、Postman及并发测试工具Jmeter、PostJson接口测试工具，设置参数传递。
两点
11-12 2万+
目录 1、ApiPost 2、postman 1、ApiPost 一般登陆接口都会有token，其他的一些接口都是需要这个token的。这个时候就可以设置参数传递。 如：apt.variables.set("TK",response.json.token);//将登陆返回的token的值，设置到TK。 然后，其他的接口需要这个token的时候引用即可，如：在headers中 也可以在body中设置，即："token":"{{TK}}" 接口工具的下载链接：APIpost 此外...
POST请求模拟工具、JSON请求工具、http接口测试、post接口测试
torrytang的专栏
06-15 4万+
Postwoman简介 (原ApiDebug) Postwoman（原apiDebug） 是一个完全免费的接口调试插件，该插件可独立使用，同时数据也能同步至云端，实现跨终端共享。Postwoman支持post、get、xml、josn等测试，支持环境切换（全局变量）。 相比于Postman等插件，Postwoman无需跨过长城即可安装使用，同时有完善的接口管理系统（postwoman.cn ...
精选资源
写接口文档的md格式文件
09-11
md写接口文档
接口文档标准模板-含Word和excel两种
02-06
接口文档是软件开发过程中的重要组成部分，主要用于定义系统或组件之间的交互方式，包括服务提供者与消费者之间的数据交换规范。本资源提供了“接口文档标准模板”，涵盖了Word和Excel两种常见格式，以适应不同团队...
精选资源
后端接口文档例子 word
03-18
"后端接口文档详解" 在本文档中，我们将详细介绍后端接口文档的编写，特别是Java接口文档的编写。通过本文档，我们将了解后端接口文档的重要性、编写格式、请求参数、返回参数等方面的知识点。 一、为什么需要后端...
十年架构师告诉你怎样写好接口文档
m0_73849256的博客
09-21 1754
●参数命名统一，下划线，驼峰…●类型定义明确，整形，长整型，浮点，对象，指针●是否需要枚举 required Enuma a●是否必填 optional int a //非必填●必要备注，说明这个字段是干啥的 required int a //不能叫a●是否需要默认值 required int a =0●如果是比较难懂的字段，贴上相关说明链接 required int a //字段说明http:heheda.com。
postjson_windows接口测试工具
12-21
postjson_windows接口测试工具，本地、在线都可以测试！
高效便捷的HTTP Post Json交互工具：Winform程序推荐
最新发布
gitblog_09720的博客
10-22 681
高效便捷的HTTP Post Json交互工具：Winform程序推荐 去发现同类优质开源项目:https://gitcode.com/ 项目介绍 在现代软件开发中，HTTP Post请求与Json数据的交互已成为一种常见的需求。为了满足Windows桌面应用程序中这一需求，我们推出了一款名为“HTTP Post提交Json与接收返回结果 Winform程序”的开源项目。该项目提供了一个简洁高效的...
post工具_Get-Post-Json的网上爬虫
weixin_39581318的博客
11-29 134
HttpClient ：HttpClient 简介 ：HttpClient 是 Apache Jakarta Common 下的子项目，可以用来提供高效的、最新的、 功能丰富的支持 HTTP 协议的客户端编程工具包，并且它支持 HTTP 协议最新的版本和建议。 HTTP 协议可能是现在 Internet 上使用得最多、最重要的协议了，越来越多的 Java 应用程序需要直接通过 HTTP 协议来访...
在线ajax请求工具,-在线工具-postjson
weixin_29306875的博客
08-06 2071
## 汉语分词### 本地版下载地址[下载地址](/doc/index)### 分词词库下载地址[分词词库](http://cdn.ouapi.com//dictionary)### 1) 请求地址```http://你本地工具启动的ip/tool/ajaxfenci```### 2) 调用方式：HTTP post### 3) 接口描述：* 对提供的汉语进行分词，以"\t" 进行分割### 4) ...
HttpUtils工具类和post请求json参数传输
伟大是熬出来的
11-30 2万+
import lombok.extern.slf4j.Slf4j; import org.apache.http.HttpEntity; import org.apache.http.NameValuePair; import org.apache.http.client.ResponseHandler; import org.apache.http.client.entity.UrlEnc...
Java解析POST提交的json数据工具类
wangli61289的专栏
12-16 4584
工具类用于解析通过网络传输json数据的参数 import java.io.IOException; import java.util.HashMap; import java.util.Iterator; import java.util.Map; import javax.servlet.http.HttpServletRequest; import net.sf.json.JSONOb
利用PostMan工具 ---post请求发送Json数据 踩坑记录
往事随风的博客
03-10 1万+
在我们平时开发中，特别是需要与接口打交道时，无论是写接口还是用接口，拿到接口后肯定都得提前测试一下，这样的话就非常需要有一个比较给力的Http请求模拟工具PostMan. post请求发送Json数据 写接口用这个真的好用， 调试简直不要太爽！ 传json到后台，用post方式，好处直接可以传一些复杂结构的数据， 通过spring的@RequestBody直接获取出对应...
从HTTP四种POST 提交数据方式，引申JSON与JSONP区别
热门推荐
没有用户名的博客
01-02 5万+
HTTP四种POST提交方式，HTTP设置请求头，ajax设置请求头，JSON与JSONP区别，浏览器跨域报错问题修复，ajax跨域问题解决
C++ api 写接口文档
05-17
要使用C++编写API接口文档，可以采用以下步骤： 1. 确定API接口的基本信息：包括接口名称、请求URL、请求方式、请求参数、返回结果等。 2. 使用注释来描述每个API接口的功能和参数：在代码中添加注释，描述每个API...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值