备案控制台

开发者社区> 问答> 正文

前后端分离，如何维护Rest API接口文档 ?

前后端分离，如何维护Rest API接口文档 ?

展开

收起

真的很搞笑 2021-10-24 20:38:50 765 0

2 条回答

写回答

取消提交回答

唐朝汤圆

可以通过接口管理框架swargge自动生成API文档，或者自研类似的框架

2021-10-25 22:41:30

赞同展开评论打赏
芯在这

前后端分离开发日益流行，大部分情况下，我们都是通过 Spring Boot 做前后端分离开发，前后端分离一定会有接口文档，不然会前后端会深深陷入到扯皮中。一个比较笨的方法就是使用 word 或者 md 来维护接口文档，但是效率太低，接口一变，所有人手上的文档都得变。在 Spring Boot 中，这个问题常见的解决方案是 Swagger ，使用 Swagger 我们可以快速生成一个接口文档网站，接口一旦发生变化，文档就会自动更新，所有开发工程师访问这一个在线网站就可以获取到最新的接口文档，非常方便。

2021-10-24 20:39:11

赞同展开评论打赏

问答分类：

API 网络架构

问答标签：

API文档 API REST API接口文档 API前后端分离

问答地址：

开发者社区 > 开发与运维 > 问答

版权声明：本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

相关问答

Flink CDC里yaml 有支持 rest api 吗？我一直是在客户端节点上 shell 上去

52

1

0

钉钉OA中审批单下拉内容是通过连接器填充的调用API发起流程时，根据官方文档的写法报错怎么解决？

89

1

0

文档智能 api文档里有word，测试页面只能是图片类或pdf，这个接口到底是否支持word文件？

30

1

0

函数计算FC的SD接口API调用文档有吗？

25

1

0

对于Flink CDC，有用 flink rest api 提交cdc pipeline 的嘛？

39

0

0

我想使用postman这类的接口工具调用api，函数计算有没有相关的接口文档？

76

1

0

钉钉盘文件覆盖上传api文档在哪？

45

1

0

请教智能媒体管理，现在API上传文档大小2m的限制还没有提高么？

50

1

0

阿里云安全文本审核增强的api文档中标签label是所有审核服务service共用的吗？

28

1

0

阿里云OpenAPI的服务端api接入这块，是否可以发送ppt等格式的文档进行虚拟数字人的调用呢？

36

0

0

问答排行榜

最热

最新

1 【大咖问答】对话PostgreSQL 中国社区发起人之一，阿里云数据库高级专家德哥 1818998

2 据说在家办公的程序员是这样写代码的？ 1793118

3 阿里云开放端口权限 690258

4 如何升级配置 536288

5 【藏经阁一起读（27）】本周推荐《Apache Flink案例集（2022版）》，你有哪些心得？ 522844

6 【精品问答】python技术1000问(1) 514124

7 Flink Forward Asia 2021 有奖问答 512903

8 OceanBase 使用动画（持续更新） 359371

9 阿里云LNAMP(Linux + Nginx + Apache + MySQL + PHP)环境一键安装脚本 329801

10 OSS存储服务-客户端工具 321567

11 为体验实验室取一个新名字。 307475

12 企业邮箱发送邮件时，若出现投递失败产生退信，内容提示包含如下： the mta server of * reply:550 failed to meet SPF requirements 或者 the mta server of 163.com — 163mx01.mxmail.netease.com(220.181.14.141) reply:550 MI:SPF mx14,QMCowECpA0qTiftVaeB3Cg—.872S2 1442548128 http://mail.163.com/help 304080

13 Win Server 2003-2016 加密勒索事件必打补丁合集 295327

14 FLASH播放器，在IE浏览器下显示请确定您的域名已完成备案和CNAME绑定 284196

15 安全组详解，新手必看教程 277341

16 写code还是做管理，开发者如何进行职业规划？ 269129

17 惊喜翻倍：免费ECS+免费环境配置~！(ECS免费体验6个月活动3月31日结束) 255880

18 阿里云手机和阿云浏览器连接问题专帖 235687

19 支付宝H5 下载的时候，提示【请确保该下载文件来源安全,如需浏览,请长按网址复制后使用浏览器访问】 227432

20 请问阿里云邮箱如何开启SMTP服务啊！ 225862

1 AI宠物更适合当代年轻人的陪伴需求吗？ 458

2 AI客服未来会完全代替人工吗？ 559

3 “云+AI”能够孵化出多少可能？ 758

4 当AI频繁生成虚假信息，我们还能轻信大模型吗？ 532

5 使用免费证书后服务器浏览器访问没有问题，外网访问显示证书不可信，使用同一种浏览器哦 114

6 FFA 2024 大会门票免费送！AI时代下大数据技术未来路在何方？ 1362

7 为什么宜搭的流程流入到钉钉OA审批，钉钉OA审批要收钱啊。。。。 130

8 宜搭UPDATE或UPSERT一次更新数据超过100条怎么办？谢谢各位大大帮帮忙！！！ 102

9 CUDA error: CUDA-capable device(s) is busy 100

10 AI时代，存力or算力哪一个更关键？ 1164

11 求宜搭关联表单的更新方法！！！ 269

12 全网寻找 #六边形战士# 程序员，你的 AI 编码助手身份标签是什么？ 1212

13 老哥们有个需求想请教一下，十分感谢 261

14 关于“通义灵码”而言，这次更新后，他更加人性化，然而我更喜欢fittencode,理由如下 314

15 关于宜搭自定义页面的文本组件循环获取其它表单的子表单数据。 101

16 flink1.20.0 部署后发布报错，是怎么回事，各种配置都配置了 143

17 关于开发者的100件小事，你知道哪些？ 1232

18 AI助力，短剧迎来创新热潮？ 1024

19 "ModelScope默认的下载位置是在哪里？ 445

20 OSS命令行工具ossutil使用问题 166

相关课程

更多

零基础学前端HTML+CSS

9194

57

去学习

推荐问答

乘风问答官招募中！机械键盘免费拿

相关电子书

更多

Spring Boot2.0实战Redis分布式缓存 立即下载

CUDA MATH API 立即下载

API PLAYBOOK 立即下载

相关实验场景

更多