java ts_从 Java 到 TS,阿里妈妈的接口管理一把梭

这两天看到知乎上的:后端开发完接口才给出接口文档,合理吗?引起了不少的讨论,说起来这是前后端分离普及之后带来的一个新问题,阿里妈妈前端团队比较早在业务中全面使用单页应用,对接口管理有过一些探索和积累,最后搞出了一套贯穿【后端代码 -> 接口测试 ->接口文档 -> Mock -> 前端代码与类型】全开发流程的接口解决方案,在集团(6000+阿里开发者)和社区(1w+ sta...
摘要由CSDN通过智能技术生成

这两天看到知乎上的:后端开发完接口才给出接口文档,合理吗?引起了不少的讨论,说起来这是前后端分离普及之后带来的一个新问题,阿里妈妈前端团队比较早在业务中全面使用单页应用,对接口管理有过一些探索和积累,最后搞出了一套贯穿【后端代码 -> 接口测试 ->接口文档 -> Mock -> 前端代码与类型】全开发流程的接口解决方案,在集团(6000+阿里开发者)和社区(1w+ stars)都有广泛的使用,这里再和大家分享一下~

前后端分离带来的变化

前后端分离其实意味着:项目的分离、开发周期的分离和开发人员的分离。

我们接到一个需求,开始项目排期,前端和后端分属两个人开发,产品经理打死也不会同意前端刷着知乎等到后端开发完接口、产出文档之后再介入开发,一定是双方并行开发最后再联调的。

在两不相见的之前,提前产出的一份接口约定可以说是必需的,不然很容易就促成联调驱动开发,项目进度一拖再拖的惨案。

除了一份接口文档,前后端分离后:

对于前端,我们需要一份准确的 Mock 数据,能够让项目摆脱后端独立运行;

对于后端,我们写起接口文档有点麻烦,最好能简化,需要能自行发起 API 请求测试接口可用性;

一次录入,多次使用,接口管理就是一把梭

我们用一个接口管理工具 Rap (http://rap2.taobao.org/) 来把这些需求一把梭解决,它大概长成下面这个样子:

Rap 可以按照团队、仓库、模块来管理细碎的接口,新建一个接口可以很轻松&

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Legal Disclaimer........................................................................................................................................................... I Preface ......................................................................................................................................................................... II Table of Contents ........................................................................................................................................................ III 1. Introduction ......................................................................................................................................................... 6 1.1. Glossary.................................................................................................................................................... 6 2. Revision History .................................................................................................................................................... 7 3. Scenario Overview ............................................................................................................................................... 8 3.1. Account Management.............................................................................................................................. 8 3.1.1. Account Status ............................................................................................................................. 8 3.1.2. Account Actions ........................................................................................................................... 8 3.1.2.1. 3.1.2.2. 3.1.2.3. 3.1.2.4. Activate ............................................................................................................................ 9 Enable, Suspend, Disable, Delete..................................................................................... 9 Set/Get Hosting Status................................................................................................... 10 SSO ................................................................................................................................. 12 3.2. Credit Limit............................................................................................................................................. 13 3.3. Billing Statement .................................................................................................................................... 13 3.4. Ticket System (Draft) .............................................................................................................................. 13 3.5. Event Notification................................................................................................................................... 15 3.6. Pricing Info and Realtime Enquiry (Draft) .............................................................................................. 15 3.7. Admin Management (Beta).................................................................................................................... 15 4. API Overview ...................................................................................................................................................... 16 4.1. Account Management............................................................................................................................ 17 4.2. Credit Limit............................................................................................................................................. 17 4.3. Billing Statement .................................................................................................................................... 17 4.4. Ticket System (Draft) .............................................................................................................................. 17 4.5. Event Notification................................................................................................................................... 18 4.6. Pricing Info (Draft) .................................................................................................................................. 18 4.7. Admin Management .............................................................................................................................. 18 4.8. Data Type ............................................................................................................................................... 18 4.9. Error Info ................................................................................................................................................ 18 5. API Call Methods ................................................................................................................................................ 19 5.1. 5.2. 5.3. Request Structure .................................................................................................................................. 20 5.1.1. Service Address .......................................................................................................................... 20 5.1.2. Communication Protocol ........................................................................................................... 20 5.1.3. Request Methods ....................................................................................................................... 20 5.1.4. Request Parameters ................................................................................................................... 20 5.1.5. Character Encoding .................................................................................................................... 20 Public Parameters .................................................................................................................................. 20 5.2.1. Public Request Parameters ........................................................................................................ 20 5.2.2. Public Return Parameters .......................................................................................................... 21 Returned Results .................................................................................................................................... 21 5.3.1. Successful Results ...................................................................................................................... 22 Version:1.3.0 III Alibaba Cloud Partners API Documentation/Table of Contents 5.3.2. Error Results............................................................................................................................... 22 5.4. Signature Mechanism ............................................................................................................................ 23 6. API References.................................................................................................................................................... 25 6.1. 6.2. 6.3. 6.4. 6.5. 6.6. 6.7. 6.8. Account Management............................................................................................................................ 25 6.1.1. CreateAccount............................................................................................................................ 25 6.1.2. GetAccountInfo .......................................................................................................................... 25 6.1.3. QueryAccounts........................................................................................................................... 25 6.1.4. SetAccountStatus ....................................................................................................................... 26 6.1.5. CreateSsoLoginUrl ...................................................................................................................... 26 6.1.6. SetHostingStatus ........................................................................................................................ 26 6.1.7. GetHostingStatus ....................................................................................................................... 27 Credit Limit............................................................................................................................................. 27 6.2.1. InitializeCreditLimit .................................................................................................................... 27 6.2.2. GetCreditLimitInfo ..................................................................................................................... 28 6.2.3. SetCreditLimit ............................................................................................................................ 28 6.2.4. SetWarningThreshold ................................................................................................................ 28 6.2.5. ClearCreditBalance..................................................................................................................... 29 Billing Statement .................................................................................................................................... 29 6.3.1. QueryResellerDailySubscription................................................................................................. 29 6.3.2. QueryResellerDaliyPAYG............................................................................................................. 30 6.3.3. QueryEndUserDailySubscription ................................................................................................ 30 6.3.4. QueryEndUserDailyPAYG............................................................................................................ 31 6.3.5. QueryResellerMonthSummary .................................................................................................. 31 6.3.6. QueryEndUserMonthSummary ................................................................................................. 32 Ticket System (Draft) .............................................................................................................................. 32 6.4.1. CreateTicket ............................................................................................................................... 32 6.4.2. QueryTickets .............................................................................................................................. 33 6.4.3. CreateTicketReply ...................................................................................................................... 34 6.4.4. GetTicketReplies......................................................................................................................... 34 6.4.5. QueryTicketProducts.................................................................................................................. 34 6.4.6. QueryProductFAQs..................................................................................................................... 35 6.4.7. GetAttachmentTempUrl............................................................................................................. 35 Event Notification................................................................................................................................... 35 Pricing Info (Draft).................................................................................................................................. 35 6.6.1. GetRegions ................................................................................................................................. 35 6.6.2. GetProducts ............................................................................................................................... 36 6.6.3. GetComponents ......................................................................................................................... 36 6.6.4. GetPrice...................................................................................................................................... 36 6.6.5. EnquiryRealtimePrice................................................................................................................. 36 Admin Management .............................................................................................................................. 38 6.7.1. CreateAdminAccount ................................................................................................................. 38 6.7.2. GetAdminAccountInfo ............................................................................................................... 38 6.7.3. QueryAdminAccounts ................................................................................................................ 39 6.7.4. SetAdminAccountStatus ............................................................................................................ 39 Data Type ............................................................................................................................................... 39 6.8.1. JsonArrayString<T> .................................................................................................................... 39 Version:1.3.0 IV Alibaba Cloud Partners API Documentation/Table of Contents 6.9. 6.8.2. DateType .................................................................................................................................... 39 6.8.3. AccountType............................................................................................................................... 39 6.8.4. AkType........................................................................................................................................ 40 6.8.5. TicketType .................................................................................................................................. 40 6.8.6. TicketStatusType ........................................................................................................................ 40 6.8.7. TicketReplyType ......................................................................................................................... 40 6.8.8. TicketProductType...................................................................................................................... 40 6.8.9. TicketProductFaqType ................................................................................................................ 41 6.8.10. AdminType ............................................................................................................................... 41 6.8.11. RellserDailySubscriptionType................................................................................................... 41 6.8.12. RellserDailyPAYGType............................................................................................................... 42 6.8.13. EndUserDailySubscriptionType ................................................................................................ 42 6.8.14. EndUserDailyPAYGType ............................................................................................................ 43 6.8.15. ResellerMonthSummaryType .................................................................................................. 43 6.8.16. ResellerMonthPordSummaryType ........................................................................................... 43 6.8.17. EndUserMonthSummaryType.................................................................................................. 44 Error Info ................................................................................................................................................ 44 6.9.1. Common Error Codes................................................................................................................. 44 6.9.2. Http Status Codes....................................................................................................................... 44 7. References.......................................................................................................................................................... 44

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值