一套程序员用的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 的调试截图 ``。
效果图：
1。年轻人创业最不能碰的行业我算是白手起家的典范，几乎做生意没投过什么钱，年轻人做生意最重要的是什么？第一，投资大。我平时最讨厌别人开奶茶店，奶茶店从我们数据上来看，倒闭了90以上，然后几乎没有成功的，动不动
指数有惊无险，我满仓做多受周末大漂亮的鹰派发言，早盘直接大幅低开后开始缓慢爬坡，最终收红盘结束，其实周末的时候我也是看到了很多空方的言论，说的天花乱坠的但是真正说明白的没几个，包括很多私募的基金经理也颇有
周二操作策略往后余生，我们一起爬最野的山喝最烈的酒撩最靓的妞打最硬的板一指数指数今天低开高走外围大跌给了早盘低开高走的机会这里指数维持震荡区间里运行不要期待大的调整！指数这里继续看区间震荡二市
家有男孩，想培养成有担当的男子汉，有15条黄金忠告请记牢闺蜜家老大是个男孩，一心想要个姑娘，于是狠下决心要了二胎，结果前段时间老二出生，又是个男孩，闺蜜欲哭无泪，还没出月子就得了产后抑郁，整天悲春伤秋，难过得不得了。不知从什么时候开始，
轲比能，一个鲜卑族首领，一顿操作把部落整得蒸蒸日上了轲比能，一个鲜卑族首领，一顿操作把部落整得蒸蒸日上了三国杀本期小叮当要给大家带来的是是一个具有超高配合性和兼容性的趣味武将，轲比能。这个人是鲜卑首领，学习汉族先进文化和技术，把他的
包揽5项大奖！这些格兰仕电器代表中国厨房新趋势8月26日，由中国家用电器协会指导中国家电网主办的2022中国厨电行业高峰论坛与美好家居沙龙在哈尔滨举行，共同探讨新时代厨房场景的新趋势与新机会。2022中国厨电行业高峰论坛上，格
华为PixLabV1发售近一月，鸿蒙3操作系统获用户超高评价7月27日华为发布了首款搭载HarmonyOS的彩色喷墨多功能打印机，仅仅一个月的时间就获得了超高的用户评价，好评如潮。从官网知乎等各大平台的用户留言可以看到，这款PixLabV1
徐开骋再出年度金句，这五段塌房明星的经典录音，听完太醒脑徐开骋上一个被全网群嘲的丁泽仁唯一的姐热度还没散去，这边徐开骋就接过了金句发言人的头衔，在互联网上为大家贡献了新的笑料。前女友张天爱公司怒怼徐开骋，称他是出轨惯犯，希望所有女孩擦亮
宋喆获刑6年将出狱？他们和王宝强的恩怨要结束了？当年王宝强妻子马蓉出轨事件也是大家有目共睹，老实人王宝强被出轨后也是非常决绝的直接在社交媒体上自爆妻子马蓉出轨丑闻，所谓家丑不可外扬，此等夺妻之恨，还是自己信赖有加的经济人，这是兄
迈克尔杰克逊唯一的女儿受尽宠爱，皮肤白到发光，身份曾被质疑Paris，帕里斯。杰克逊，大家都亲昵地叫她小巴黎。从1998年出生起，就成为备受关注的人，只因为，她是美国超级巨星迈克尔杰克逊唯一的女儿。当她在2020年爆出和男友加布里埃尔要进
张翰，都38岁了，还没长大呢？在无人在意的角落，由张翰自己当编剧当制片人当出品人组局拉人主演的东八区的先生们开播了。这是一部男性群像剧，被宣传为男版三十而已，中年版的欢乐颂。但看完播出的4集后，小8只想说张翰，
主动秀句型havedifficulty（troubleahardtime）（in）doingsth。havedifficulty（troubleahardtime）（in）doingsth。做某事有困难或havedifficulty（troubleahardtime）（in）st全球首创糖尿病降糖新药多格列艾汀，患者实测第47天1夜间情况凌晨0点血糖4。9，截至凌晨6点止，血糖最低值为4。6，最高为5。1，平均血糖值为4。8，均处于正常范围。2早餐后情况早起8。02服用了半片多格列艾汀片，9。00分早餐，回味狂飙曹闯不值得同情，临终之言别有用心，拿捏李响一生很多人同情曹闯，是因为他和孟德海的那晚对话，刺痛了很多郁郁不得志的中年人。是啊，很多有能力有业绩的中年人，被困于年龄学历出身入职方式等不可改变的过去，以至于晋升没他加薪没他。李响宁太原人！甲流来势汹汹！老中医提醒饮食要忌口，牢记3吃3不吃，助力身体快恢复少受苦甲流强势袭来，如何吃才能提高免疫力呢？入春后，天气转暖，万物复苏。春天是细菌滋生的活跃期，也是流感的高发季节。为顺利度过甲流高峰期，我们除了要做好自我防护，戴好口罩，勤洗手以外，还一些对你人生有用的句子1。别人说得出口，你就应该拒绝得出口。不要觉得不好意思。2。幸福的人也会给我们带来幸福，这是世界上最简单的经济学。3。人不能只记得自己跋山涉水去见过谁，那些千里迢迢来见我们的人一样加快释放农村消费潜力农村居民是我国消费内需的重要主体，农村市场是我国市场经济的重要组成部分。近年来，我国乡村社会消费品零售总额乡村居民人均消费支出乡村网络零售额均保持快速增长，汽车家电数码产品美妆产品2死3残1流产，女公安副局长凌娅麻烦大了，自首恐怕和这件事有关株洲市公安局副局长凌娅投案自首的消息，谁也没想到会掀起如此之大的波浪。人们开始是对她的自首疑惑不解，堂堂的一个公安副局长，犯了一般错误，能把自己保护得严丝合缝，主动投案自首，到底是株洲市公安局女副局长投案，吸毒涉黑，内幕揭开令人不寒而栗好内容我来评随着反腐败斗争的不断深入，坚持打虎拍蝇两手都要硬已成常态。2023年3月3月，湖南省株洲市公安局女副局长凌娅涉嫌严重违纪违法，自动投案，接受株洲市纪委监委纪律审查和监察巾帼护学队水上护学岗云南公安开启护学模式民警开启护学模式云南网讯（记者赵岗通讯员王婷）冬去春来，开学季如期而至，为保障2023年春季学期护学工作顺利进行，近日，云南各地公安机关提前谋划多警部署，第一时间开启护学模式，积极北宅市场监管所积极开展农村大集食品安全专项检查工作大众网海报新闻记者侯祥家通讯员董娜青岛报道为保障辖区农村大集食品经营良好秩序，确保群众饮食安全，近日，北宅市场监管所积极开展农村大集食品安全专项检查工作。村大集主要以蔬菜水果畜禽肉漫步在王府井步行街，感受有情感有温度有血有肉的雷锋3月1日雷锋同志铜像在王府井步行街揭幕。漫步在王府井步行街，在雷锋铜像前伫立，从雷锋欢快温暖的神情中，我深深感受到一个有情感有温度有血有肉的雷锋。雷锋，原名雷正兴，出生于湖南长沙，