接口文档一般由谁写，接口文档编写

大家好，今天小编来为大家解答接口文档一般由谁写这个问题，接口文档编写很多人还不知道，现在让我们一起来看看吧！

什么是接口文档,如何写接口,有什么规范

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

目的是：项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发。项目维护中或者项目人员更迭，方便后期人员查看、维护。

规范是：以/a开头，如果需要登录才能调用的接口(如新增、修改；前台的用户个人信息，资金信息等)后面需要加/u，即：/a/u；中间一般放表名或者能表达这个接口的单词；get方法，如果是后台通过搜索查询列表，那么以/search结尾，如果是前台的查询列表，以/list结尾；url参数就不说了。

API（Application Programming Interface，应用程序接口）是一些预先定义的接口（如函数、HTTP接口），或指软件系统不同组成部分衔接的约定。用来提供应用程序与开发人员基于某软件或硬件得以访问的一组例程，而又无需访问源码，或理解内部工作机制的细节。

应用程序接口又称为应用编程接口，是一组定义、程序及协议的集合，通过 API接口实现计算机软件之间的相互通信。API的一个主要功能是提供通用功能集。

API同时也是一种中间件，为各种不同平台提供数据共享。程序设计的实践中，编程接口的设计首先要使软件系统的职责得到合理划分。良好的接口设计可以降低系统各部分的相互依赖，提高组成单元的内聚性，降低组成单元间的耦合程度，从而提高系统的可维护性和可扩展性。

java API是谁写的

你要先搞清楚 API的概念:

API=应用编程接口(=application program interface)

所以： java API=用java写的应用编程接口

通常狭义地理解，都把 java API理解为 JDK的类库所提供的引用编程接口了。

广义理解的话，任何一个人编写的任何一个类，发布后类所提供的 public方法都可以理解为编程接口。

所以你的问题可以这样回答：

如果仅仅讲 JDK的类库所提供的 API，那么它们是开发 jdk的牛们组成的团队共同努力的结晶。

如果说到广义的 java API，那么会用 java编程的人都可以写。

当然，你千万别把java API的本质理解很多人所用的用来查阅 java类库的 html和 chm文档，那样的文档全称应该是：java API合集文档。文档的作用是帮助程序员更方便地了解、使用 java API，文档不是 java API的本质。

任何一个人，开发的正确的 java程序代码，写上正规的注释，然后用 JDK的 javadoc工具就可以生成对应的 java api文档。

接口文档编写

一.什么是接口

API（Application Programming Interface）即应用程序接口，可以任务是一个软件组件或一个Web服务与外界进行交互的接口，在这里接口可以和API划等号。

二.为什么编写接口文档

1、项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发

2、项目维护中或者项目人员更迭，方便后期人员查看、维护

3、测试人员验证检查接口是否正确

三.接口文档有谁编写

正规的团队合作或者是项目对接，接口文档是非常重要的，一般接口文档都是通过开发人员写的。一个工整的文档显得是非重要。

四.接口文档格式

1.在线版格式

2.word版格式

这就是接口文档的格式如何编写的了，我这里不是用自己手写的，而是用的一款叫apipost的接口测试和接口文档生成工具生成的，它还可以生成html和markdown格式的接口文档。

不想自己写文档的同学可以是去试试这款软件。

www.apipost.cn​www.apipost.cn