一文详解 API 设计最佳实践
Java资料站
共 3481字,需浏览 7分钟
· 2021-09-06
点击上方蓝色字体,选择“标星公众号”
优质文章,第一时间送达
- 前言 -
- 为什么要使用 API? -
API 可以让外部应用访问您的资源 API 扩展了应用程序的功能 API 允许开发者重用应用逻辑 API 是独立于平台的,它们传递数据不受请求平台的影响
- 数据建模与结构化 -
https://api.domain.com/authors
https://api.domain.com/authors/{id}/books
- 编写面向资源的 API -
Base Path -> 作者 (集合) -> profile (资源)
书 (资源)
命名集合和资源时使用美式英语(例如:color 而不是 colour) 避免拼写错误 使用更简单、更常用的词来保持清晰,例如 delete 而不是 remove 如果你使用的资源与其他 API 使用的资源相同,请使用相同的术语以保持一致。 对集合使用复数形式(例如:authors、books 等)。
- RESTful 接口 -
创建数据 Create 读取数据 Read 更新数据 Update 删除数据 Delete
- API 版本控制 -
- 了解主要和次要更新 -
https://api.domain.com/v1.0/authors
https://api.domain.com/2020-06-15/authors
https://api.domain.com/authors
x-api-version:v1
- 分页 -
STRING page_token(在请求中发送) STRING next_page_token(由 API 返回) INT page_size(在请求中发送)
作者:Varun Joshi
来源:
https://codeburst.io/best-practices-api-design-61d4697d17ff
评论
光纤详解:光纤跳线如何分类,多向单模转换?
本文来自“光纤详解:光纤跳线如何分类,多向单模转换?”,光纤跳线作为光网络布线最基础的元件之一,被广泛应用于光纤链路的搭建中。如今,光纤制造商根据应用场景的不同推出众多类型的光纤跳线,如MPO/LC/SC/FC/ST光纤跳线,单工/双工光纤跳线,单模/多模光纤跳线等,它们之间各有特色,且不可替代。本
架构师技术联盟
0
从原理到实践:掌握DPDK内存池技术
前言:本文整理下之前的学习笔记,基于DPDK17.11版本源码分析。主要分析一下内存管理部分代码。一、概述内存管理是数据面开发套件(DPDK)的一个核心部分,以此为基础,DPDK的其他部分和用户应用得以发挥其最佳性能。本系列文章将详细介绍DPDK提供的各种内存管理的功能。但在此之前,有必要先谈一谈为
开源Linux
0
springboot第70集:字节跳动后端三面经,一文让你走出微服务迷雾架构周刊
创建一个使用Kubernetes (K8s) 和 Jenkins 来自动化 GitLab 前端项目打包的CI/CD流水线,需要配置多个组件。下面,我将概述一个基本的设置步骤和示例脚本,以帮助你理解如何使用这些工具整合一个自动化流程。前提条件确保你已经有:Kubernetes 集群:用于部署 Jenk
程序源代码
0
GPT的风也吹到了CV,详解自回归视觉模型的先驱! ImageGPT:使用图像序列训练图像 GPT模型
作者丨科技猛兽编辑丨极市平台导读 在 CIFAR-10 上,iGPT 使用 linear probing 实现了 96.3% 的精度,优于有监督的 Wide ResNet,并通过完全微调实现了 99.0% 的精度,匹配顶级监督预训练模型。本文目录1 自回归视觉模型的先驱 ImageGPT:
机器学习初学者
0
微服务与领域驱动设计,架构实践总结
来源:知了一笑👉 欢迎加入小哈的星球 ,你将获得: 专属的项目实战 / Java 学习路线 / 一对一提问 / 学习打卡 / 赠书福利全栈前后端分离博客项目 2.0 版本完结啦, 演示链接:http://116.62.199.48/ ,新
小哈学Java
0
面试官:电商库存扣减如何设计?如何防止超卖?
来源:my.oschina.net/xiaolyuh/blog/1615639👉 欢迎加入小哈的星球 ,你将获得: 专属的项目实战 / Java 学习路线 / 一对一提问 / 学习打卡 / 赠书福利全栈前后端分离博客项目 2.0 版本完结啦, 演示
小哈学Java
0
PyPy为什么能让Python比C还快?一文了解内在机制
我的小册:(小白零基础用Python量化股票分析小册) ,原价299,限时特价2杯咖啡,满100人涨10元。来源:机器之心「如果想让代码运行得更快,您应该使用 PyPy。」—— Python 之父 Guido van Rossum对于研究人员来说,迅速把想法代码化并查看其是否行得通至关重要。Pyth
菜鸟学Python
0
Stability AI开放Stable Diffusion 3 API,在线免费使用
「Stability AI」宣布开放其最新文本到图像生成模型「Stable Diffusion 3」的API接口,供开发者和企业使用。该模型采用创新的多模态扩散转换器架构,在字体、细节还原、提示理解等方面表现优异,评测结果超越了业内其他顶尖系统。与DALL-E 3和Midjourney v6等最先进
IQ前端
0