导出离线文档_接口文档是该前端定义还是后端定义?-程序员宅基地

技术标签: 导出离线文档  

f0c8f869fcb2879cce8bd0a783303545.gif

朋友公司新项目,他负责后端开发,因为之前做过全栈的项目,基本前后台思路都门清,就自己把逻辑走通写了api接口,新招了个ios过来说他写的接口不行,就干了一架。

4cfba52f4c7a58286bb26b868d18c635.png

那么接口文档到底是该谁来定义呢?

接口是什么?

API,全称是ApplicationProgramming Interface,即应用程序编程接口,我们日常中习惯简称为“接口”。接口是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。

接口有什么用?

在平时的开发过程中,前后端经常会进行数据交互,那么在前后端分离的项目中,前端就不用管后台的工作,用api调取数据即可。

接口文档该由谁来写呢?

笔者认为一般接口文档一定是后端来写,只是我们要事先要和前端商量定义,然后再编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。

通俗一点就是:客户端出接口需求,服务端出接口方案。

为什么要写接口文档?

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

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

接口规范是什么?

首先接口分为四部分:方法、url、请求参数、返回参数

1、方法:新增(post) 修改(put) 删除(delete) 获取(get)

2、url:uri地址里不允许出现大写字母,如果是两个单词拼接,用/分开

3、请求参数和返回参数,都分为5列:字段、说明、类型、备注、是否必填

4、返回参数结构可以有一个结构体也可以有多个结构体

6191f30ce13ffc571df0460818e9bffa.png

showDoc

ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具,可以用他来写接口文档。

2747b99ae3050a11abaa4e073792086e.png

showdoc且有如下较多亮点1:支持markdown语法(所有的api接口写作现在都支持这个吧,因为他现在太方便了)2:支持多用户协作,你可以在项目下面随意添加多个用户一起完成api文档的写作。3:可以分享并导出项目,生成需要的文档格式如doc,可以离线浏览4:支持响应式,手机电脑同样精彩5:支持项目转让6:支持模版插入7:支持历史版本,你可以把操作恢复到以前的版本。8:showdoc完全开源9:可以部署到自己的服务器10:如果在线使用,可以设置自己的个性域名,也可以对文档进行加密,浏览者需要密码才能访问11:可以通过一个在线测试api的工具,直接生成markdown,你几乎不用写代码就能过所有的参数自动生成

当然还有其他类似的平台也可以满足在线编辑规范接口的平台:eolinker,apidoc,sosoapi等

github.com/eolinker
github.com/caixw/apidoc
eolinker,apidoc都是开源的项目有兴趣可了解,可自己搭建测试api和自动生成api文档

作者:程序员的枯燥生活 来源:https://www.toutiao.com/a6747592508726837773/

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/weixin_30670103/article/details/112631242

智能推荐

while循环&CPU占用率高问题深入分析与解决方案_main函数使用while(1)循环cpu占用99-程序员宅基地

文章浏览阅读3.8k次,点赞9次,收藏28次。直接上一个工作中碰到的问题,另外一个系统开启多线程调用我这边的接口,然后我这边会开启多线程批量查询第三方接口并且返回给调用方。使用的是两三年前别人遗留下来的方法,放到线上后发现确实是可以正常取到结果,但是一旦调用,CPU占用就直接100%(部署环境是win server服务器)。因此查看了下相关的老代码并使用JProfiler查看发现是在某个while循环的时候有问题。具体项目代码就不贴了,类似于下面这段代码。​​​​​​while(flag) {//your code;}这里的flag._main函数使用while(1)循环cpu占用99

【无标题】jetbrains idea shift f6不生效_idea shift +f6快捷键不生效-程序员宅基地

文章浏览阅读347次。idea shift f6 快捷键无效_idea shift +f6快捷键不生效

node.js学习笔记之Node中的核心模块_node模块中有很多核心模块,以下不属于核心模块,使用时需下载的是-程序员宅基地

文章浏览阅读135次。Ecmacript 中没有DOM 和 BOM核心模块Node为JavaScript提供了很多服务器级别,这些API绝大多数都被包装到了一个具名和核心模块中了,例如文件操作的 fs 核心模块 ,http服务构建的http 模块 path 路径操作模块 os 操作系统信息模块// 用来获取机器信息的var os = require('os')// 用来操作路径的var path = require('path')// 获取当前机器的 CPU 信息console.log(os.cpus._node模块中有很多核心模块,以下不属于核心模块,使用时需下载的是

数学建模【SPSS 下载-安装、方差分析与回归分析的SPSS实现(软件概述、方差分析、回归分析)】_化工数学模型数据回归软件-程序员宅基地

文章浏览阅读10w+次,点赞435次,收藏3.4k次。SPSS 22 下载安装过程7.6 方差分析与回归分析的SPSS实现7.6.1 SPSS软件概述1 SPSS版本与安装2 SPSS界面3 SPSS特点4 SPSS数据7.6.2 SPSS与方差分析1 单因素方差分析2 双因素方差分析7.6.3 SPSS与回归分析SPSS回归分析过程牙膏价格问题的回归分析_化工数学模型数据回归软件

利用hutool实现邮件发送功能_hutool发送邮件-程序员宅基地

文章浏览阅读7.5k次。如何利用hutool工具包实现邮件发送功能呢?1、首先引入hutool依赖<dependency> <groupId>cn.hutool</groupId> <artifactId>hutool-all</artifactId> <version>5.7.19</version></dependency>2、编写邮件发送工具类package com.pc.c..._hutool发送邮件

docker安装elasticsearch,elasticsearch-head,kibana,ik分词器_docker安装kibana连接elasticsearch并且elasticsearch有密码-程序员宅基地

文章浏览阅读867次,点赞2次,收藏2次。docker安装elasticsearch,elasticsearch-head,kibana,ik分词器安装方式基本有两种,一种是pull的方式,一种是Dockerfile的方式,由于pull的方式pull下来后还需配置许多东西且不便于复用,个人比较喜欢使用Dockerfile的方式所有docker支持的镜像基本都在https://hub.docker.com/docker的官网上能找到合..._docker安装kibana连接elasticsearch并且elasticsearch有密码

随便推点

Python 攻克移动开发失败!_beeware-程序员宅基地

文章浏览阅读1.3w次,点赞57次,收藏92次。整理 | 郑丽媛出品 | CSDN(ID:CSDNnews)近年来,随着机器学习的兴起,有一门编程语言逐渐变得火热——Python。得益于其针对机器学习提供了大量开源框架和第三方模块,内置..._beeware

Swift4.0_Timer 的基本使用_swift timer 暂停-程序员宅基地

文章浏览阅读7.9k次。//// ViewController.swift// Day_10_Timer//// Created by dongqiangfei on 2018/10/15.// Copyright 2018年 飞飞. All rights reserved.//import UIKitclass ViewController: UIViewController { ..._swift timer 暂停

元素三大等待-程序员宅基地

文章浏览阅读986次,点赞2次,收藏2次。1.硬性等待让当前线程暂停执行,应用场景:代码执行速度太快了,但是UI元素没有立马加载出来,造成两者不同步,这时候就可以让代码等待一下,再去执行找元素的动作线程休眠,强制等待 Thread.sleep(long mills)package com.example.demo;import org.junit.jupiter.api.Test;import org.openqa.selenium.By;import org.openqa.selenium.firefox.Firefox.._元素三大等待

Java软件工程师职位分析_java岗位分析-程序员宅基地

文章浏览阅读3k次,点赞4次,收藏14次。Java软件工程师职位分析_java岗位分析

Java:Unreachable code的解决方法_java unreachable code-程序员宅基地

文章浏览阅读2k次。Java:Unreachable code的解决方法_java unreachable code

标签data-*自定义属性值和根据data属性值查找对应标签_如何根据data-*属性获取对应的标签对象-程序员宅基地

文章浏览阅读1w次。1、html中设置标签data-*的值 标题 11111 222222、点击获取当前标签的data-url的值$('dd').on('click', function() { var urlVal = $(this).data('ur_如何根据data-*属性获取对应的标签对象

推荐文章

热门文章

相关标签