专栏首页陶士涵的菜地[日常] 编写HTTP接口文档

[日常] 编写HTTP接口文档

一、什么是接口文档? 在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。 二、为什么要写接口文档? 1、项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发 2、项目维护中或者项目人员更迭,方便后期人员查看、维护

RESTful 接口: REST 是一个很流行的前后端交互形式的约定。这只是一套约定,并不是某个技术标准.REST 充分利用了 HTTP 规范中的方法,达到接口描述的语义化

安全: 1.使用HTTPS协议 2.数据加密

权限处理: 1.客户端接口,携带验证token 2.WEB端接口,使用SESSION验证机制

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • [Go] gocron源码阅读-空接口类型interface{}

    gocron源代码中的Action那个地方,就是个空接口类型Action interface{},可以传递任意类型进去,这里是传了个函数进去

    陶士涵
  • [javaSE] 标识符大小写

    陶士涵
  • [vuejs] 聊天框在overflow:auto中填数据时滚动到底部

    在一个聊天的界面中 , 当我们固定了高度 , 并且设置了overflow:auto ,会出现滚动条 , 但是填充数据后 ,滚动条是不会跟着滚,数据隐藏在下面

    陶士涵
  • Java入门 - 面向对象 - 06.接口

    原文地址:http://www.work100.net/training/java-interface.html

    光束云
  • 如何做API接口测试?

    经常有后端开发会问,后端接口都测试什么?怎么测?简单梳理了一下接口测试的相关内容:

    软测小生
  • Java编程思想精粹(九)-接口

    尽管你的第一想法是创建接口,但对于构建具有属性和未实现方法的类来说,抽象类也是重要且必要的工具。毕竟你不可能总是使用纯粹的接口。

    JavaEdge
  • Java编程思想精粹(On Java8)(十)-接口

    尽管你的第一想法是创建接口,但对于构建具有属性和未实现方法的类来说,抽象类也是重要且必要的工具。 你不可能总是使用纯粹的接口。

    JavaEdge
  • 多态的灵魂,面向接口的程序设计,这才是你该懂得的接口

    比如,显示器中封装了很多电子元器件,这些元器件连接在一起为显示器的正常共工作提供支持,那显示器如何与外界的其他设备(如电脑主机、外放音响、耳机等设备)通信交互呢...

    老夫编程说
  • 数据结构与算法2016-06-03

    一个算法调用自己来完成它的部分工作,在解决某些问题时,一个算法需要调用自身。如果一个算法直接调用自己或间接调用自己,就称这个算法是递归的。根据调用方式的不同,它...

  • Java基础系列(二十四):接口入门

    接口主要用来描述类具有什么功能,而并不给出每个功能的具体实现。一个类可以实现一个或多个接口,并在需要接口的地方,随时使用实现了相应接口的对象。接口主要就是对行为...

    山禾说

扫码关注云+社区

领取腾讯云代金券