精华内容
下载资源
问答
  • 我刚接触这行,人给了我一份接口文档,叫我接口,存进数据库之后之后用定时任务每分钟取一次.......这里说的接口到底是些个什么,是service还是dao,希望指导一下谢谢
  • 通过接口文档,需要弄清楚下面几条信息: 1、确定请求方式——post 2、拿到URL: http://11.11.111.111:8080 3、接口的路径:/a/b 4、请求参数 hostName,hostType,fromTime,endTime,collectType...

    直接先贴图(文中的url做了修改):

    代码如下:

    @FeignClient(name = "Z_KPI_API",url = "${Z.KPI.url:http://11.11.111.111:8080}",fallback = ZApiClientFallback.class)
    public Interface ZApiClient{
        @PostMapping(path = "a/b",produces = "application/json")
        ZQueryResult query( @RequestParam("hostName")String hostName,
                            @RequestParam(name = "hostType",defaultValue = "ne")String hostType,
                            @RequestParam("fromTime")String fromTime,
                            @RequestParam("endTime")String endTime,
                            @RequestParam(name = "cpllectType",defaultValue = "Zabbix")String collectType,
                            @RequestParam(name = "history",required = false)Integer history); 
    
    
    }

    通过接口文档,需要弄清楚下面几条信息:

    1、确定请求方式——post

    2、拿到URL:http://11.11.111.111:8080

    3、接口的路径:/a/b

    4、请求参数

    hostName,hostType,fromTime,endTime,collectType,history

    5、返回形式:JSON

    6、并且需要知道,返回值表示的意思

     

    技术总结:

    1、@FeignClient

    本次例子,用到的参数是name,url,fallback

    2、@RequestParam

    本次例子,用到的参数是name,required

    可以通过required=false或者true来要求@RequestParam配置的前端参数是否一定要传 ,此处history不一定要传。不传的话会给参数赋值为null。

    注意:GET和POST请求传的参数会自动转换赋值到@RequestParam 所注解的变量上

    3、@PostMapping

    本次例子,用到的参数是path,produces

    关于PostMapping和GetMapping有

    https://blog.csdn.net/linjpg/article/details/76927075

     

     

     

     

    展开全文
  • restful前后端分离api接口文档模板,javaweb开发接口文档
  • 接口模板 接口文档

    千次下载 热门讨论 2016-05-20 16:54:01
    接口模板 接口文档
  • java开发使用的接口说明文档模板
  • 怎么写接口文档

    千次阅读 2020-03-14 22:52:27
    一些刚开始写接口文档的服务端同学,很容易按着代码的思路去编写接口文档,这让客户端同学或者是服务对接方技术人员经常吐槽,看不懂接口文档。这篇文章提供一个常规接口文档的编写方法,给大家参考。

    一些刚开始写接口文档的服务端同学,很容易按着代码的思路去编写接口文档,这让客户端同学或者是服务对接方技术人员经常吐槽,看不懂接口文档。这篇文章提供一个常规接口文档的编写方法,给大家参考。

    推荐使用的是 http://docway.net 写接口文档,方便保存和共享,支持导出PDF MARKDOWN,支持团队项目管理。

    一、请求参数

    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对内容进行描述。
    在这里插入图片描述

    三、接口说明

    说明接口的应用场景,特别的注意点,比如,接口是否幂等、处理是同步方式还是异步方式等。

    四、示例

    上个示例(重点都用红笔圈出来,记牢了):
    在这里插入图片描述

    接口工具

    推荐使用的是 http://docway.net(以前叫小幺鸡) 写接口文档,方便保存和共享,支持导出PDF MARKDOWN,支持团队项目管理。

    展开全文
  • 接口文档标准模板-含Word和excel两种

    热门讨论 2018-02-06 09:36:51
    接口文档标准的模板,包含Word和excel两种模板。满足各种语言接口需要。
  • 海康平台集成接口,包括视频、门禁、车辆等。iVMS-8700_V2.9.1和iVMS-5000_V6.9平台SDK
  • api接口文档模板

    千次下载 热门讨论 2014-03-06 16:00:51
    api接口文档模板
  • 测试奇谭:接口测试实战项目01:接口测试环境搭建 这次,我们正式进入测试阶段。 为什么要做接口测试 这个问题的答案很多,我这里只给大家做个引子。 01 可以精确定位bug 比如:当你在测试某网页时,发现网页...

    大家好,我是测试奇谭的作者风风。

    上两次,我们已经了解:

    测试奇谭:什么是接口测试?这篇文章让你明白

    测试奇谭:接口测试实战项目01:接口测试环境搭建

    这次,我们正式进入测试阶段。

     

    为什么要做接口测试

    这个问题的答案很多,我这里只给大家做个引子。

    01 可以精确定位bug

    比如:当你在测试某网页时,发现网页显示的数据不正确,你该怎么办?

    初级测试,直接提bug给开发;高级测试,会定位bug,而要定位bug,就要熟悉接口。

    02 提高测试效率

    有了01,自然会有提效方面的考虑,这是其一。

    其二,如果你测的项目是前后端分离的,后端的提测时间往往早于前端提测时间。如果你是后端测试,你要等着前端提测之后,才开始测试吗?

    此时,你需要接口测试,先把后端的接口过一遍,有问题尽早解决。

    03 从技术角度去熟悉业务,发现程序的隐患

    现在很多中大型公司都在倡导:测试要会走查开发的代码,通过代码更深入地理解业务。

    业务代码走查的第一步,往往是从接口开始——看调用,看后端逻辑处理,再看后端返回数据,这些和接口的知识息息相关。

    ……

     

    接口文档

    在进行接口测试之前,我们需要了解接口文档这个概念。

    接口文档,说白了,就是供人查看的文档(一般采用Restful风格编写),通过规范接口文档编写标准,保证不同的人写出来的文档可读性和可维护性俱佳。

    不然A是一个书写风格,B是一个书写风格……N是一个书写风格。作为测试的你,拿到一份AB……N类风格接口文档,你崩溃不?

    打开测试奇谭之前提供的接口测试项目,里面有一份接口文档。

    阅读接口文档,除了必要的描述外,关键信息在于接口资源:

    01 熟悉接口资源(蓝色部分)

    URL定位资源:一个URL(接口)定位一个资源(你想拿到的东西)

    methond操作资源:即你想要对这个东西做什么操作(初学了解GET-查、POST-增、PUT-改、DELETE-删,即可)

    02 请求资源(黄色部分)

    如图所示,传入数据(一般是json数据格式),发起请求

    03 响应:请求的结果(红色部分)

    请求的响应码 + 响应的结果(一般是json数据格式)

    而关于json格式的讲解,看这个图就够了(值得收藏哟~)

     

    接口请求上手操练

    了解接口文档后,我们上手来操练一波。

    01 启动项目,打开postman02 阅读接口文档中,关于添加学院信息的部分

    03 发起请求(和上文的红黄蓝部分一一对应理解哦~)

    http://127.0.0.1:8099/api/departments/
    {"data":[        {"dep_id":"T01","dep_name":"Test学院","master_name":"Test-Master","slogan":"Here is Slogan"        }    ]

    以上,成功!

     

    一如既往,做个总结

    01 接口测试其实没那么复杂,只是你没有接触它而已;

    02 建议上手操作。

    展开全文
  • 这里大概有三四十个字段,如果一个的对着接口文档异常耗时,就是个苦力活,那有没有什么办法可以实现快速生成这种简单的代码呢?我们的接口文档用的是Swagger 可以看到其实接口文档上对应的中文名和字段都是有...

    此方案针对后台管理系统类,新增表单字段特别多的情况,如下
    在这里插入图片描述
    这里大概有三四十个字段,如果一个的对着接口文档来写异常耗时,就是个苦力活,那有没有什么办法可以实现快速生成这种简单的代码呢?我们的接口文档用的是Swagger
    在这里插入图片描述
    可以看到其实接口文档上对应的中文名和字段都是有的了,其实只需要把这个格式解析出来,然后循环一下就可以了。我们的接口文档有一个复制文档功能,复制出来是markdown文档,是这个样子的,我们只需要把表格部分复制出来解析就可以了。
    在这里插入图片描述
    下面是实现的方法

    var { Extractor } = require('markdown-tables-to-json');
    
    let md = `
    
    | label         | 请求类型     |     required |  type      |  --   |  --  |
    | ------------ | -------------------------------- |-----------|--------|----|--- |
    | fAreaId  | 大区id,整数类型 |   body    |   true   |integer(int64)  |       |
    | fCaptainTel  | 车长电话 |   body    |   true   |string  |       |
    | fCarsetCaptain  | 车长 |   body    |   true   |string  |       |
    | fCarsetCaptainId  | 车长id,整型 |   body    |   true   |integer(int64)  |       |
    | fCarsetDeputy  | 副车长 |   body    |   true   |string  |       |
    | fCarsetDeputyId  | 副车长id |   body    |   true   |integer(int64)  |       |
    | fCompanyApprove  | 公司特批:有特批,无特批 |   body    |   true   |string  |       |
    | fContractDesc  | 合同说明 |   body    |   false   |string  |       |
    | fContractName  | 合同名称 |   body    |   false   |string  |       |
    | fContractSituation  | 合同情况 |   body    |   true   |string  |       |
    | fCustomerCity  | 城市 |   body    |   false   |string  |       |
    | fCustomerId  | 客户id,整数类型 |   body    |   true   |integer(int64)  |       |
    `
    
    // 这里只写了一个input如果想更细致些,可以自己写判断来处理
    function input(label,code){
      return`
        <el-col :span="6">
              <el-form-item label="${label}" prop="${code}">
                <el-input v-model="form.${code}"></el-input>
              </el-form-item>
            </el-col>
            `
    }
    
    
    let mdData = Extractor.extractObject(md);
    let html = ''
    
    for(let key in mdData){
    	 html = html + input(mdData[key].label,key)
    }
    
    console.log(html)
    

    打印出来的效果,自己再放到页面中做一些调整就可以了
    在这里插入图片描述

    展开全文
  • java接口文档规范

    2017-06-01 10:55:27
    文档为md格式
  • 根据接口文档撸代码的心得

    千次阅读 2017-02-22 18:20:43
     文档接口很多大概一两百,每个接口的参数个数不统一,有些是post,有些是get 如果像这样:public String methodA(String arg1,String arg2 ...){ httpClientUtil.post(...); } public String
  • 接口文档编辑工具+接口文档编写

    千次阅读 2020-03-05 19:12:03
    接口文档编辑工具 参考@Lucky锦【接口文档编辑工具】 Swagger: 通过固定格式的注释生成文档. 省时省力,不过有点学习成本。https://swagger.io/ eoLinkerhttps://www.eolinker.com/#/ ShowDoc(我使用的是这个,...
  • java API接口文档

    2013-03-07 12:03:04
    API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。
  • 这是商城App后台接口说明文档,很全,根据文档可以自己设计数据库,以有比较清晰的项目功能模块划分。。。
  • API 接口 设计文档 模板

    千次下载 热门讨论 2014-05-28 11:52:14
    API 接口 设计文档 模板,保存日后使用。
  • 什么是接口文档?接口文档书写规范?

    千次阅读 2018-12-14 14:37:34
    在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。  接口文档分为四部分:请求方法type、请求...
  • 写接口文档及生成mock数据

    千次阅读 2018-09-11 18:15:17
    写接口文档及生成mock数据 在web应用开发的过程中,与前端联调时总会有一些接口,需要接口文档,在接口先行的情况下,前端不能拿到实际的接口进行开发,所以就需要mock数据。 今天搜索了下,阿里在这方面已经有...
  • 在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。二、为什么要写接口文档?1、项目开发过程中...
  • 网站地址:https://www.showdoc.cc 第一步:注册 第二步:填写注册信息,这里填写用户名和密码即可,用户名不可重复,... ...也可以不注册查看示例决定要不要使用这个网站来写接口文档。...第五步:API接口文档 ...
  • 正确规范写接口文档

    万次阅读 多人点赞 2018-05-17 14:14:27
    前言 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员的。一个工整的文档显得是非重要。下面我总结下自己看到的优秀接口文档。银联接口文档案例:5.2.2 统一收单线下交易查询...
  • 接口文档要如何

    万次阅读 多人点赞 2015-04-21 14:36:11
    一个简单的接口文档完给组长看后,发现漏洞百出。下面总结一下文档需要注意事项: 封皮 封面最好是本公司规定的封面,有logo,内容标题,版本号,公司名称,文档产生日期。(错误地方在于,文档的标题要和页眉...
  • laravel接口 接口文档

    千次阅读 多人点赞 2018-11-11 19:07:29
    接口 先在控制器里一个接口的方法 之所以了两个方法 因为写接口单独创建一个控制器比较好 避免与页面展示冲突 // 展示页面 配合城市接口执行 public function cityshow(){ $data = DB::table('jy_city')-&...
  • 教你怎么后台接口文档

    万次阅读 多人点赞 2019-08-15 18:47:08
    文章目录用户登陆用户注册左侧树形菜单加载文章查询文章新增文章修改文章删除 用户登陆 http请求方式: POST https://xxx.xxx.xxx:8080/项目命名/vue/userAction_login.action 参数 ...result...
  • java快速生成接口文档方法总结

    千次阅读 2021-07-27 19:36:22
    常常在项目收尾阶段,客户需要项目的接口文档,或者是一个大的sass平台,各个产品之间互相调用的时候,需要对方提供接口文档 通常来说,接口文档属于产品的技术沉淀,是一个长期积累的过程,然而,很多时候,开发...
  • 教你写接口需求文档

    千次阅读 2020-07-19 12:00:00
    作者:果果 转载已取得作者授权一、什么是接口百科上对接口的定义:API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,目的...
  • 没有接口文档,如何接口测试

    千次阅读 2019-03-19 10:42:10
    1、接口文档没有提及的一个查询的接口 文档没有提及根据手机号查询交易流水 2、WEB根据手机号查询交易流水 3.postman的接口测试 (1)路径url:postman的url和前端的url是一样的 (2)发送请求:post ...
  • 接口&接口文档

    万次阅读 2018-09-02 23:16:41
    一、接口简介 API(Application Programming Interface)即应用程序接口,可以任务是一个软件组件或一个Web服务与外界进行交互的接口,在这里接口可以和API划等号。 接口可以简单的理解为一个黑盒子,从一边输入...
  • 汇付天下接口文档

    热门讨论 2014-03-22 12:45:26
    汇付天下接口文档,商户专属平台接口规范V1,做第三方平台支付必看

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 924,883
精华内容 369,953
关键字:

根据接口文档写接口