一套程序员用的HTTP协议模板
程序员利器之 Markdown格式，以下是具体内容。# xxx 的 HTTP 协议说明 1. 支持的协议，必须是基于 RESTFul 架构的 HTTP 协议，数据传输的格式要求为 JSON 。 2. 请按文档说明，使用响应的 HTTP Method（ GET、POST）。 3. `rdsBaseUrl` 为： - `http://host:8080/api` 。 - `https://host:8090/api` 。 4. Request 和 Response 正文均基于 JSON，UTF-8 编码。如果有问题，尝试设置 HTTP 请求 Header 的 content-type 和 accept 为 `application/json` 。 5. 请正确处理 HTTP Response Status，如 200、201、204、400、401、403、404、405、500、502。每个接口文档会有详细说明。 6. 如有歧义（尤其是需要上位系统提供数据的地方），及时交流。 【更新记录】 | 序号 | 时间 | 操作者 | 备注 | | :--: | :--------: | :----: | ---------------------- | | 1 | 2023-01-01 | xxx | 第一版协议。 | | 2 | 2023-01-02 | xxx | ① 修改了接口1的描述。 | | | | | | 【接口列表】 | 序号 | 接口名称 | 备注 | | :--: | -------- | ------------------------------------- | | 1 | 模板1 | 没有任何参数的接口模板 | | 2 | 模板2 | 只有请求正文（RequestBody）的接口模板 | | | …… | | | n | 模板n | | ## 模板1 - 无任何请求参数 ### 接口描述 简要的描述这个接口的功能和用法。 > 例如： > > 通过调用此接口实现XXX功能需求的数据交互。 ### URL ```http POST rdsBaseUrl/interface-template1 ``` 【请求参数（Params）】 ``根据实际的需求，和客户协商``，格式如下。 > 如果没有请求参数的需求，需说明 **无请求参数**。 | 参数名称 | 参数描述 | 数据类型 | 必填 | 备注 | | :------: | :------: | :------: | :--: | ---- | | - | - | - | - | - | 调用接口时，示例为 `http://host:8080/api/interface-template1` 。 ### 请求正文（RequestBody） ``根据实际的需求，和客户协商``，格式如下。 > 如果没有请求参数的需求，需说明 **无请求正文**。 | 参数名称 | 参数描述 | 数据类型 | 必填 | 备注 | | :------: | :------: | :------: | :--: | ---- | | - | - | - | - | - | ### 响应（Response） 【响应正文（ResponseBody）】 ``根据实际的需求，和客户协商``，格式如下。 | 字段名称 | 字段描述 | 数据类型 | 必填 | 备注 | | :------: | :--------: | :------: | :--: | ------------------------------------------------------------------------------------ | | field-1 | 字段描述-1 | 字符串 | 是 | field-1 的备注。例如：
无论请求成功与否，值都为 `＂value-1＂` 。 | | filed-2 | 字段描述-2 | 布尔值 | 是 | field-2 的备注。例如：
请求成功时，值为 `true` ；请求失败时值为 `false` 。 | | field-n | 字段描述-n | 数值 | 是 | field-3 的备注。例如：
请求成功时，值为 `10000` ；请求失败时值为 `10001` 。 | - 请求成功时，响应码（ResponseCode）为 200 ，响应正文为 JSON 格式的数据，示例如下： ```json { ＂field-1＂: ＂value-1＂, ＂field-2＂: true, ＂field-n＂: 10000 } ``` - 请求失败时，响应码（ResponseCode）为 400 ，响应正文为 JSON 格式的数据，示例如下： ```json { ＂field-1＂: ＂value-1＂, ＂field-2＂: false, ＂field-n＂: 10001 } ``` ### Postman 示例 ``添加 Postman 的调试截图``。 ## 模板2 - 只要求请求正文 ### 接口描述 简要的描述这个接口的功能和用法。 ### URL ```http POST rdsBaseUrl/interface-template2 ``` 【请求参数】 ``根据实际的需求，和客户协商``，格式如下。 | 参数名称 | 参数描述 | 数据类型 | 必填 | 备注 | | :------: | :------: | :------: | :--: | ---- | | - | - | - | - | - | 调用接口时，示例：`http://host:8080/api/interface1-template2` 。 ### 请求正文（RequestBody） ``根据实际的需求，和客户协商``，格式如下。 | 参数名称 | 参数描述 | 数据类型 | 必填 | 备注 | | :------: | :--------: | :------: | :--: | ------------------------------------------------- | | arg-1 | 参数描述-1 | 字符串 | 是 | arg-1 的备注。例如：默认值为 `＂arg-value-1＂` 。 | | arg-2 | 参数描述-2 | 数值 | 是 | arg-2 的备注。例如：默认值为 `1` 。 | | arg-n | 参数描述-n | 字符串 | 是 | arg-2 的备注。例如：默认值为 `＂arg-value-n＂` 。 | 请求正文为 JSON 格式的数据，示例如下： ```json { ＂arg-1＂: ＂arg-value-1＂, ＂arg-2＂: 1, ＂arg-n＂: ＂arg-value-n＂ } ``` ### 响应（Response） 【响应正文（ResponseBody）】 ``根据实际的需求，和客户协商``，格式如下。 | 字段名称 | 字段描述 | 数据类型 | 必填 | 备注 | | :------: | :--------: | :------: | :--: | ------------------------------------------------------------------------------------ | | field-1 | 字段描述-1 | 字符串 | 是 | field-1 的备注。例如：
无论请求成功与否，值都为 `＂value-1＂` 。 | | filed-2 | 字段描述-2 | 布尔值 | 是 | field-2 的备注。例如：
请求成功时，值为 `true` ；请求失败时值为 `false` 。 | | field-n | 字段描述-n | 数值 | 是 | field-3 的备注。例如：
请求成功时，值为 `10000` ；请求失败时值为 `10001` 。 | - 请求成功时，响应码（ResponseCode）为 200 ，响应正文为 JSON 格式的数据，示例如下： ```json { ＂field-1＂: ＂value-1＂, ＂field-2＂: true, ＂field-n＂: 10000 } ``` - 请求失败时，响应码（ResponseCode）为 400 ，响应正文为 JSON 格式的数据，示例如下： ```json { ＂field-1＂: ＂value-1＂, ＂field-2＂: false, ＂field-n＂: 10001 } ``` ### Postman 示例 `此处`添加 Postman 的调试截图 ``。
效果图：
南瓜丰收制成饼欢欢喜喜送乡邻0000视频加载中红网时刻新闻11月15日讯（记者康晓乔通讯员龙俊霓）眼下正是南瓜丰收的季节，在湖南省靖州县二凉亭村，村民和志愿者们将刚刚采摘的南瓜制成南瓜饼，送给村里的老人和儿童
全球连线当德国技术遇上中国食材德国香肠专家打造海南本土品牌视频加载中来自德国的凯费斯克是一位建筑师，但如今他更被人熟知的身份却是香肠专家。2006年，凯和中国妻子在海口成立了一家建筑设计公司。由于经常出差，他们发现海南各大酒店的香肠基本都
读书不惧岁月长蒋乐瑶日出为大地送来光明，日落又带走天光。人就在晨曦与黄昏的转换中生存成长，从孩童到暮年不知历经了多少晴雨交织。谁也无法阻挡光阴，谁也无法抵御时代的洪流。我曾问过自己羡慕哪种人？我
写给妈妈明天就是妈妈去世的第三十天了，按照惯例，我们应该回老家去妈妈的坟头上烧五七纸祭拜，可是老家现在基本处于静默的状态，北京出京后返京又很困难，和家里长辈商量后暂时先不回去。只在此刻聊以
做一粒铜豌豆炒破命运的锅做一粒铜豌豆炒破命运的锅回家真好。巴拉尼望着天空说。他像一只囚禁了很久的鸟，渴望天空的自由。终于回到维也纳了，街道还像老朋友一样熟悉，天空还像以前一样一如既往的的蓝，蓝得像令人心醉
假如你死了，会发生哪些事？假如你死了在得到消息的那一刻，你身边所有至亲将会心如刀绞一样，趴在你身上痛不欲生，抱怨你的独自离开，仿佛有流不干的眼泪，感觉没你活不下去了。第二天，很多亲朋好友得知了你离世的消息，
怎么去外求我说的那个圆，一直都在，它时时刻刻影响着这个世界。前面我说了怎么去内求，今天来分享一下，我们可以外求什么。内求之后生成了一个强大的你，其实很多人还是需要去外求的，因为外是你生活所处
每个人都应该有敬畏之心每个人都应该有敬畏之心山西贾虎林什么是敬畏？敬畏是人类对待事物的态度。一个人有了敬畏之心，胸中就有了方向行为准则和规范，就能自觉约束自己，不做出格越轨之事。古人说凡善怕者，心身有所
字母哥美国首发库汤詹杜巴约，打不过有我卢卡大帝的国际队近日，字母哥参加队友伊巴卡的美食节目HowHungryAreYou？，伊巴卡让字母哥从国际球员和美国球员中各选出一套最强的首发五虎，字母哥给出了答案美国队库里克莱詹姆斯杜兰特和阿德
巴厘岛进入G20时间，主要谈些啥？这是疫情以来，全球多国领导人首次线下面对面交流。据新华社报道，二十国集团（G20）领导人第十七次峰会将于11月15日至16日在印度尼西亚巴厘岛举行。此次巴厘岛峰会以共同复苏强劲复苏
3个67岁退休老人坦言人到晚年才明白，最亲的人并不是老伴导语晚年很多人过日子基本都是跟老伴相依为靠，可说晚年最亲的人不是老伴那又是谁呢？可很显然事实比较残酷，即使多年的夫妻成仇人，住一起却如同陌生人的也不在少数。3个67岁退休老人自述人
我们要不要向狼学习？几千年来，一代又一代，一轮又一轮，我们这片土地上狼烟四起，争斗不休，杀伐不绝，每一次改朝换代，都毁灭掉大批的精英人物和千千万万个劳苦大众，我们国家的历史是嗜血的，他沉重的车轮每前进止咳大救星找到了！2元1个，常喝提神止咳，滋补润肺，喉咙不干痒今天我将为大家介绍一种经济实惠的滋补食材白萝卜。白萝卜是一种常见的根茎蔬菜，它的味道清香爽口，含有丰富的维生素C胡萝卜素蛋白质等多种营养成分，有助于提高免疫力和保护皮肤。此外，白萝游记12春江待水暖，击水会有时游记12春江待水暖，击水会有时2023年2月17日，星期五，农历正月二十七。预报说武汉天气，多云，513度，东南风2级，空指68良。虽然年节过完了，可是街头仍然是人头涌动，人们似乎我旅途足迹之走进藏家这次我们走进藏家，品尝酥油茶和青稞酒。接待我们的这家出过一个活佛，所以向客人送的是黄色的哈达。献哈达是对对方表示纯洁诚心忠诚尊敬的意思。听说门口堆的木柴越多，说明女主人越能干。这是胡明轩平时杜导叫我和徐杰一起训练要求我们承担起更多责任直播吧3月2日讯CBA常规赛，广东主场107101战胜山西。赛后广东后卫胡明轩在场边接受了采访。谈到时隔三年重返主场，胡明轩说道经历了三年，第一次主场有这么多观众，球迷们也终于等到放宽市场准入！福州发布新政，开民宿有利好推动多个片区集中打造一批特色休闲民宿，放宽民宿市场准入，被评定为甲级的旅游民宿一次性给予30万元奖励陈暖摄最新政策发布，在福州开民宿有利好！福州市人民政府办公厅关于促进福州市民宿高他5岁封王，8岁拜相，9岁被亲哥赐死，临终遗言竟流传千年为何最是无情帝王家？自古以来为了争夺皇权，有多少人不惜同室操戈，手足相残。才华横溢的曹植，为此写下了七步诗本是同根生，相煎何太急。在中国五千年历史长河中，南北朝是一段很混乱的时期，2022SLG复盘阿里4399买量腰斩，三七入局抢量，这一营销趋势正在崛起图片来源视觉中国文DataEye过去一年，国内SLG赛道内卷不断加剧2022上半年各方集结参与买量大战，而下半年蚂蚁题材却异军突起。经过2022这一年，SLG大厂除了蚂蚁题材的两家豆类炒货龙头，甘源食品渠道变迁企业浮沉，千亿坚果大有可为（报告出品方分析师中信证券薛缘汤学章）甘源食品籽坚果龙头，进军树坚果口味坚果炒货领跑者甘源食品是国内豆类炒货龙头公司，擅长口味坚果研发。甘源食品成立于2006年，擅长研发口味丰富的国产手机为什么卖不过iPhone？会不会和这些事情有关系？从旗舰机内卷到中端机内卷，透露着这几个本质。1，消费者买手机更加理性，不再简单地追逐性能或配置，对旗舰机的需求下降。2，现在的手机市场就是买方市场，消费者有绝对的话语权。3，手机知干散货航运业深度研究时隔20年，中国需求再次成为阶段性主导（报告出品方作者申万宏源研究，闫海邹杰伟）1。航运周期位置讨论我们在航运长周期中周期短周期的什么位置？长周期船龄周期上行（我们在新造船20212038上行周期的起点）。行业技术进步