一套程序员用的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月12日，施耐德电气关键电源创新实验室在上海正式启动运营。该实验室将全面支持并推进施耐德电气关键电源储能等产品系统的全球研发战略，助力数据中心产业转型升级与创新发展。记者对该实验
人口下滑！消费负增长，房地产投资暴跌10财经新势力新春季周二，我们公布了2022年的经济成绩，全年GDP增长只有3，远远低于年初5。5的目标值。实际上，完全符合预期！第一，没有疫情的时候，我就说了全年5。5的目标是不可能
北京租房市场调研房源充足，租金下降马上要过年了，目前北京地区租房量整体比较少，房源量很充裕，成交的基本都是到期换租的人群。近日，多位租房中介人士对中国证券报记者表示。租金出现松动租金价格方面，中国证券报记者调研发现
人民币市场汇价（1月18日）新华社北京1月18日电中国外汇交易中心1月18日受权公布人民币对美元欧元日元港元英镑澳元新西兰元新加坡元瑞士法郎加元林吉特卢布兰特韩元迪拉姆里亚尔福林兹罗提丹麦克朗瑞典克朗挪威克朗
2022年中国LiFSI行业发展现状专利申请量及价格走势分析原文标题2022年中国LiFSI（双氟磺酰亚胺锂）上游工艺成本及原料供给现状图一LiFSI（双氟磺酰亚胺锂）产业概述锂电池电解液主要由溶剂添加剂和锂盐三部分组成。锂盐方面而言，目前
A股高开，消费游戏板块走强，大金融遇冷中新经纬1月18日电18日，A股三大指数集体高开。上证指数涨0。10，报3227。59点，深证成指涨0。11，报11813。38点，创业板指涨0。12，报2548。70点。来源Wi
增加200亿元！金融活水灌溉里水中小型企业搭建政银企对接平台，引金融活水润泽实体经济。近日，里水镇举办2023年政银企座谈会，布局规划2023年度金融工作，现场提出一项年度目标2023年，金融机构各项贷款余额同比增加100
国家发展改革委2023年有信心有能力保持物价总体稳定本报记者周岩最近召开的中央经济工作会议明确要求，2023年要突出做好稳增长稳就业稳物价工作。2022年我国物价整体情况如何？如何做好今年的稳物价工作？如何保障春节期间重要民生商品价
茅台卖冰激凌少林寺进军房地产盘点2022年十大跨界，你看好哪一个？还记得茅台冰激凌李宁咖啡保时捷菜刀法拉利风衣吗？1月18日，天眼查发布2022年度十大跨界。1。茅台跨界冰淇淋创2。62亿营收2022年5月，由茅台与蒙牛联名出品，蒙牛马鞍山工厂生
朱永新如何让孩子放下手机捧起书籍？父母是孩子的第一任教师，推动世界的手就是摇摇篮的手。让父母重视幼儿的精神成长，让父母意识到幼儿阅读的重要性，让父母学会怎样给孩子选书读书，在这些父母需要的时候，提供有效帮助，这是目苹果原装线相同快充体验，魅族PANDAERMFi认证CtoLightning线拆解前言苹果手机自带的Lightning数据线以不耐用著称，其采用的环保材质在使用一段时间后会开裂损坏，影响使用。苹果也意识到这个问题，在iMac中标配了一条编织线，延长线缆的使用寿命缩量续做MLF加大逆回购操作规模央行此举有何深意？央行缩量操作中期借贷便利（MLF），同时增量操作逆回购。根据央行公告显示，11月15日在公开市场开展8500亿元MLF操作和1720亿元公开市场逆回购操作。根据数据显示，11月ML长期封控与经济衰退成正比长期封控与经济衰退成正比近期根据国务院联防联控二十条指示河北石家庄市，广东广州市等地逐步取消了全员核酸检测，这主要考虑到过分防疫已经严重影响了经济发展，一是减轻政府经济负担，二是减钢价刷新近一个月新高，后期会大幅反转吗上周宏观基本面发生了一些积极的变化，对国内钢材市场的影响较大。我们总结归纳为三大利好一优化疫情防控工作二十条细则公布二金融支持房地产市场平稳发展十六条措施公布三美国国内通货膨胀率小拿下电池专利金奖，却反遭多方质疑，董明珠押宝押错了？明明拿了大奖，却没听到掌声，格力这么没人缘？今年8月初，格力旗下专注钛酸锂电池研发的格力钛，一举拿下了第23届中国专利奖金奖，并且成为新能源行业里唯一获奖者。不过在格力获奖后，网上1980年，华人世界船王包玉刚，3天调集21亿赢得九龙仓始末1980年的6月20日是一个星期五，当天有世界船王之称的包玉刚，正在国外参加一个船运业的大会，本来按照日程安排，他下周一要去见墨西哥的总统。但从香港传来的一个消息，却让他立刻推辞了增进相互理解深化三国合作第九届中日韩合作对话召开当前，全球面临发展与冲突的突出矛盾的背景下，如何抓住区域全面经济伙伴关系协定（RCEP）实施的机遇，深化东亚经贸合作，推动区域经济发展，成为中日韩三国面临的共同课题。2022年11熊市见底，未来可期，星星之火，可以燎原，我们再出发文江湖盟主（22。11。13发表，现重发）年初我说今年是熊市，压制全球股市的三座大山加息，俄乌局势，疫情，而这三座大山背后的本质根源就是通货膨胀，以下简称通胀，通胀用指标CPI表示10月新能源车批发销量榜长安首次跻身前五，东风易捷特进入前十10月，比亚迪以超21万辆的批发销量，遥遥领先再次夺冠，紧随其后的是特斯拉和上汽通用五菱。得益于糯玉米奔奔EStar等车型的热销，长安超过吉利和埃安首次跻身前五。东风易捷特销量突破家居行业胡润百富榜红星美凯龙董事长财富缩水最多近日，胡润研究院发布2022胡润百富榜，榜单显示，共1305位个人财富50亿元人民币以上的企业家上榜，比去年减少了11（160人），上榜企业家总财富为24。5万亿元人民币，比去年下