多平台统一管理软件接口,如何实现多平台统一管理软件接口
326
2022-11-21
本文目录一览:
1、怎么写api接口
一些刚开始写接口文档的服务端同学,很容易按着代码的思路去编写接口文档,这让客户端同学或者是服务对接方技术人员经常吐槽,看不懂接口文档。这篇文章提供一个常规接口文档的编写方法,给大家参考。
一、请求参数
1. 请求方法
GET
用于获取数据
POST
用于更新数据,可与PUT互换,语义上PUT支持幂等
PUT
用于新增数据,可与POST互换,语义上PUT支持幂等
DELETE
用于删除数据
其他
其他的请求方法在一般的接口中很少使用。如:PATCH HEAD OPTIONS
2. URL
url表示了接口的请求路径。路径中可以包含参数,称为地址参数,如**/user/{id}**,其中id作为一个参数。
3. HTTP Header
HTTP Header用于此次请求的基础信息,在接口文档中以K-V方式展示,其中Content-Type则是一个非常必要的header,它描述的请求体的数据类型。
常用的content-type:
application/x-www-form-urlencoded
请求参数使用“”符号连接。
application/json
内容为json格式
application/xml
内容为xml格式
multipart/form-data
内容为多个数据组成,有分隔符隔开
4. HTTP Body
描述http body,依赖于body中具体的数据类型。如果body中的数据是对象类型。则需要描述对象中字段的名称、类型、长度、不能为空、默认值、说明。以表格的方式来表达最好。
示例:
二、响应参数
1. 响应 HTTP Body
响应body同请求body一样,需要描述请清除数据的类型。
另外,如果服务会根据不同的http status code 返回不同的数据结构, 也需要针对不同的http status code对内容进行描述。
三、接口说明
说明接口的应用场景,特别的注意点,比如,接口是否幂等、处理是同步方式还是异步方式等。
四、示例
上个示例(重点都用红笔圈出来,记牢了):
使用好多粉提交百度ocpc 数据时需要填写token,获取方法如下:
一.搜索推广用户
百度推广后台>oCPC>转化追踪>新建转化追踪(如图:点击放大查看)
2.选择API回传方式>得到token(如图:点击放大查看)
3.选择API回传方式>设置转化信息,选择微信号复制按钮点击复制token(如图:点击放大查看)
二.信息流用户
百度信息流推广后台> 工具中心>转化追踪工具> 新建转化(如图:点击放大查看)
2.选择API线索类得到token(如图:点击放大查看)
新网站让百度快速收录,主要有以下几种方法:
1、注册百度站长工具
想让搜索引擎收录你的网站,最快速的方法就是向百度提交你的站点。告诉搜索引擎有你这么一个站。
2、向搜索引擎提交你的网址
用SITE指令,查看网站的收录情况,没有收录,点击“提交网址”,将新站网址提交给搜索引擎。
3、登录百度站长工具,进入链接提交页面,将网址输入完整,点击提交。
4、每日更新网站内容
网址提交给搜索引擎后,要做到每日更新网站的内容,让搜索引擎知道你这个站是活跃的,新站都是有观察期的,所以,要想快收录在观察期不可偷懒。
5、做好内链建设
搜索引擎评分的一大标准,其中内链与外链均占大比重,所以,在网站的页面中做好内链建设很重要。内链并非随意堆砌,在一个页面中每个链接都是有相关性的,引导蜘蛛爬取多个页面。同时,对于访问的用户也是很好的体验。
6、外链适当做
不用急着过度优化,先让搜索引擎来审核你,考核你,过了考察期再逐步做。当然,基础的优化还是必须要做好的。像外链不需要急着做。每天加1-3个的外链足矣,加多了,有作弊嫌疑。
开发版本代码包只能存在一个,后提交的代码包将覆盖原有代码包。
版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。
发表评论
暂时没有评论,来抢沙发吧~