什么是接口文档?接口文档书写规范?

        在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。

        接口文档分为四部分:请求方法type请求路径url、请求参数、返回参数

        书写接口文档最好在线书写,这样前后端的都可以进行阅读。并且可以通过权限,设置每个人在书写文档时候的权限。在线接口文档链接地址:https://www.showdoc.cc

     来一波流程图:

    一、注册登录

   

二、建立 文件夹及文件

 三、书写接口

 四、书写接口

 

  • 6
    点赞
  • 13
    收藏
    觉得还不错? 一键收藏
  • 2
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值