与API标签相关的技术文章 - 时代Java，与您同行！

时代Java，与您同行！关注微信公众号，关注前沿技术，微信搜索：nowjava或时代Java，也可点击这里扫码关注

时代Java

登录注册

与 “API” 标签相关内容。

Java API 最佳设计实践：在模块化和非模块化 Java 环境中使用

让您的 API 可同时在模块化和非模块化 Java 环境中使用

欢马劈雪 2019-09-11 09:34:53 2019-09-11 09:34:53

java， API，设计实践
OpenAI新开放了这些好用的API功能

带有视觉能力的 GPT-4，有时也称为 GPT-4V 或 gpt-4-vision-preview ，在 API 中，允许模型接收图像并回答有关它们的问题。该模型最擅长回答有关图像中存在的内容的一般问题。虽然它确实了解图像中对象之间的关系，但它尚未优化以回答有关图像中某些对象位置的详细问题。例如，你可以问它汽车是什么颜色的，或者根据冰箱里的东西，晚餐的一些想法可能是什么，但如果你给它看一个房间的图像，并问它椅子在哪里，它可能无法正确回答问题。

欢马劈雪 2023-11-28 06:02:45 2023-11-28 06:02:45

OpenAI， API，功能
REST API 面临的 7 大安全威胁

REST API 面临的 7 大安全威胁互联网安全是技术博客和论坛讨论得越来越频繁的一个话题，并且理由充分：近年来，众多引人注目的安全漏洞显著增多。安全性非常重要，特别是在 REST API 领域。

Xebcnor 2019-12-13 08:32:07 2019-12-13 08:32:07

REST， API，安全，威胁
Java API

既然你已经知道如何配置 MyBatis 和创建映射文件,你就已经准备好来提升技能了。 MyBatis 的 Java API 就是你收获你所做的努力的地方。正如你即将看到的,和 JDBC 相比, MyBatis 很大程度简化了你的代码而且保持简洁,很容易理解和维护。MyBatis 3 已经引入了很多重要的改进来使得 SQL 映射更加优秀。

欢马劈雪 2020-08-04 05:37:59 2020-08-04 05:37:59

java， api， mybatis，文档
HTTP API 设计指南

我们的目标是保持一致性，专注业务逻辑同时避免过度设计。我们一直试图找出一种良好的、一致的、显而易见的 API 设计方法，而并不是所谓的"最终/理想模式"。

欢马劈雪 2020-12-28 01:56:55 2020-12-28 01:56:55

http， api，设计，指南
组件 API

ReactComponentReact 组件实例在渲染的时候创建。这些实例在接下来的渲染中被重复使用，可以在组件方法中通过 this 访问。唯一一种在 React 之外获取 React 组件实例句柄的方式就是保存 React.render 的返回值。在其它组件内，可以使用 refs 得到相同的结果。setStatesetState(object nextState[, function callback])合并 nextState 和当前 state。

欢马劈雪 2020-08-04 05:37:59 2020-08-04 05:37:59

组件， api， react，中文版
顶层 API

ReactReact 是 React 库的入口。如果使用的是预编译包，则 React 是全局的；如果使用 CommonJS 模块系统，则可以用 require() 函数引入 React。React.createClassReactClass createClass(object specification)创建一个组件类，并作出定义。组件实现了 render() 方法，该方法返回一个子级。该子级可能包含很深的子级结构。

欢马劈雪 2020-08-04 05:37:59 2020-08-04 05:37:59

顶层， api， react，中文版
描述稳定性

描述您的 API 的稳定性或是它在各种各样节点环境中的完备性和稳定性，例如：加上原型版（prototype）/开发版（development）/产品版（production）等标记。更多关于可能的稳定性和改变管理的方式，查看 Heroku API compatibility policy一旦你的 API 宣布产品正式版本及稳定版本时，不要在当前 API 版本中做一些不兼容的改变。如果你需要，请创建一个新的版本的 API。

欢马劈雪 2020-08-04 05:37:59 2020-08-04 05:37:59

描述，稳定性， http， api，设计
提供可执行的例子

提供可执行的示例让用户可以直接在终端里面看到 API 的调用情况，最大程度的让这些示例可以简单的使用，以减少用户尝试使用 API 的工作量。例如:$ export TOKEN=... # acquire from dashboard$ curl -is https://$TOKEN@service.com/users如果你使用prmd生成 Markdown 文档，每个节点都会自动获取一些示例。

欢马劈雪 2020-08-04 05:37:59 2020-08-04 05:37:59

提供，可执行，例子， http， api
可读性

机器可读的 JSON 模式提供一个机器可读的模式可以精确的指定你的 API。使用 prmd 来管理你的模式，并确保它能被prmd verify 验证。人类可读的文档提供人类可读的文档让客户端开发人员可以理解你的 API。如果你用 prmd 创建了一个概要并且按上述要求描述，你可以为所有节点很容易的使用prmd doc生成 Markdown文档。

欢马劈雪 2020-08-04 05:37:59 2020-08-04 05:37:59

可读性， http， api，设计，指南
生成结构化的错误

响应错误的时，生成统一的、结构化的错误信息。包含一个机器可读的错误 id，一个人类能识别的错误信息（message），根据情况可以添加一个url来告诉客户端关于这个错误的更多信息以及如何去解决它，例如:HTTP/1.1 429 Too Many Requests{ "id": "rate_limit", "message": "Account reached its API rate limit.", "url": "https://docs.service.

欢马劈雪 2020-08-04 05:37:59 2020-08-04 05:37:59

生成，结构化，错误， http， api
嵌套外键关系

使用嵌套对象序列化外键关联，例如:{ "name": "service-production", "owner": { "id": "5d8201b0..." }, // ...}而不是像这样:{ "name": "service-production", "owner_id": "5d8201b0...", ...

欢马劈雪 2020-08-04 05:37:59 2020-08-04 05:37:59

嵌套，关系， http， api，设计
提供标准的时间戳

为资源提供默认的创建时间 created_at 和更新时间 updated_at，例如:{ ... "created_at": "2012-01-01T12:00:00Z", "updated_at": "2012-01-01T13:00:00Z", ...}有些资源不需要使用时间戳那么就忽略这两个字段。

欢马劈雪 2020-08-04 05:37:59 2020-08-04 05:37:59

提供，标准，时间戳， http， api
最小化路径嵌套

在一些有父路径/子路径嵌套关系的资源数据模块中，路径可能有非常深的嵌套关系，例如:/orgs/{org_id}/apps/{app_id}/dynos/{dyno_id}推荐在根(root)路径下指定资源来限制路径的嵌套深度。使用嵌套指定范围的资源。在上述例子中，dyno 属于 app，app 属于 org 可以表示为：/orgs/{org_id}/orgs/{org_id}/apps/apps/{app_id}/apps/{app_id}/dynos/dynos/{dyno_id}

欢马劈雪 2020-08-04 05:37:59 2020-08-04 05:37:59

最小化，路径，嵌套， http， api
路径和属性要小写

为了和域名命名规则保持一致，使用小写字母并用-分割路径名字，例如：service-api.com/usersservice-api.com/app-setups属性也使用小写字母，但是属性名要用下划线_分割，以便在Javascript中省略引号。例如：service_class: "first"

欢马劈雪 2020-08-04 05:37:59 2020-08-04 05:37:59

路径，属性，小写， http， api
返回合适的状态码

为每一次的响应返回合适的HTTP状态码。

欢马劈雪 2020-08-04 05:37:59 2020-08-04 05:37:59

返回，合适，状态， http， api
为内省而提供 Request-Id

为每一个请求响应包含一个Request-Id字段，并使用 UUID 作为该值。通过在客户端、服务器或任何支持服务上记录该值，它能主我们提供一种机制来跟踪、诊断和调试请求。

欢马劈雪 2020-08-04 05:37:59 2020-08-04 05:37:59

内省，提供， request-id， http， api
支持 Etag 缓存

, identifying the specificversion of the returned resource. The user should be able to check forstaleness in their subsequent requests by supplying the value in theIf-None-Match header.在所有的请求中带上 ETag 头，用于识别特定版本的返回资源。用户可以在随后的请求中通过提供 If-None-Match头的值来检查内容是否过期。

欢马劈雪 2020-08-04 05:37:59 2020-08-04 05:37:59

支持， etag，缓存， http， api
隔离关注点

设计时通过将请求和响应之间的不同部分隔离来让事情变得简单。保持简单的规则让我们能更关注在一些更大的更困难的问题上。请求和响应将解决一个特定的资源或集合。使用路径（path）来表明身份，body 来传输内容（content）还有头信息（header）来传递元数据（metadata）。查询参数同样可以用来传递头信息的内容，但头信息是首选，因为他们更灵活、更能传达不同的信息。

欢马劈雪 2020-08-04 05:37:59 2020-08-04 05:37:59

隔离，关注点， http， api，设计
API Reference

5.1. Promise#then promise.then(onFulfilled, onRejected);then 代码示例 var promise = new Promise(function(resolve, reject){ resolve("传递给then的值"); }); promise.then(function (value) { console.log(value); }, function (error) { console.error(error); });

Xebcnor 2020-08-04 05:37:59 2020-08-04 05:37:59

api， reference， javascript， promise，迷你

Java API 最佳设计实践：在模块化和非模块化 Java 环境中使用

OpenAI新开放了这些好用的API功能

REST API 面临的 7 大安全威胁

Java API

HTTP API 设计指南

组件 API

顶层 API

描述稳定性

提供可执行的例子

可读性

生成结构化的错误

嵌套外键关系

提供标准的时间戳

最小化路径嵌套

路径和属性要小写

返回合适的状态码

为内省而提供 Request-Id

支持 Etag 缓存

隔离关注点

API Reference

热门标签

社区

关于