api-design 相关问题

API设计是确定和公开一组旨在供其他开发人员使用以允许以编程方式访问数据的一致方法签名,返回值和文档的过程。

如何注释返回类型取决于其参数的函数?

在 Python 中,我经常编写函数来过滤集合以查找特定子类型的实例。 例如,我可能会在 DOM 中查找特定类型的节点,或者在......中查找特定类型的事件。

回答 1 投票 0

重构WCF服务

我最近不得不向我编写的现有应用程序添加一个新功能,并查看这部分代码,意识到可能是时候进行重构和改进了。 原始索引方法: 是用户注册...

回答 1 投票 0

GET方法的restful子对象最佳实践

我经常面临restful api设计问题,我不知道该怎么办。实际上我找不到任何最佳实践/线索来知道如何继续...... 例如,对于 GET 路线,我有: ...

回答 1 投票 0

REST API 上下文中集合和存储之间的区别

REST API 上下文中集合资源原型和存储资源原型之间的确切区别是什么,我一直在阅读这本名为 REST API 设计规则手册的书,而不是...

回答 1 投票 0

在干净架构和 DDD 中处理用例中的多个参与者

我正在使用 Clean Architecture 和 DDD 为博客网站编写 API。我发现自己正在做一个用例来获取所请求文章的所有评论。问题是匿名用户可以看到评论...

回答 1 投票 0

如何使用 Flask 提供 HTML 和 JSON 内容?

我想设置一个具有 GUI 和 API 组件的 Flask 应用程序。 这是一个检索组列表的简单示例: def get_groups(): groups = db.session.query(SgmGroup.group_name).

回答 3 投票 0

从这个 init 函数返回 bool 的目的是什么

我正在查看 TI 为其 MSP430 设备提供的 driverlib 中的代码,我感到有些惊讶和疑问。为了清楚地说明这一点,我们以 ADC 的初始化函数为例(相同

回答 1 投票 0

已知.Net项目的API策略[已关闭]

我正在为我的应用程序编写一个 API,并且有一些悬而未决的问题(考虑到版本控制)。 用户应该直接调用我的对象还是需要我提供一些抽象? 应该由用户编写的代码

回答 2 投票 0

在 Azure 上托管 API 的最佳方式,可以服务巨大的负载(每秒 100K 请求)

我需要帮助设计一个可以每秒处理 100K 请求(突发)的 Web API 系统 (.NET 6.0)。 我需要做的就是公开一个 HTTP 端点,该端点将使用 Cosmos DB 进行一些计算......

回答 2 投票 0

根据路径参数(Vert.x)将请求转发到不同的verticle

我第一次使用 Vert.x 来尝试用 Java 构建 API。现在我可以在我的主 verticle 中使用 eventBus 将某些路由(例如 /example/:name 等)转发到发送...的处理程序

回答 1 投票 0

接受可能互斥的函数参数的惯用方法是什么?

我正在构建一个公开函数的小型库: 等待 printLib({optionsObj}) 目前, options 参数是一个具有不同(可选)属性的对象。 答: 乙?: 我正在构建一个公开函数的小型库: await printLib({optionsObj}) 目前,options 参数是一个具有不同(可选)属性的对象。 A?: <boolean> B?: <boolean> C?: <boolean> 用户可以将 true 或 false 传递给任何选项。但是 A 和 B 不能同时为 true,否则会抛出错误。 在我的例子中,虽然A和B不能同时为真,但B和C可以具有相同的布尔值。 如何放置我的论点,以便用户直观地了解哪些选项可以组合在一起,哪些选项不能组合在一起? 是否需要重新设计功能? 一种解决方案是采用 string 值作为参数:"A" | "B" | "C"。然而,当所有可能的选项(A、B、C)互斥 - A 或 B 或 C 时,应应用此方法。 如何放置我的论点,以便用户直观地了解哪些选项可以组合在一起,哪些选项不能组合在一起? 一般的解决方案将涉及创建类型定义(例如 .d.ts 文件),TypeScript 在这种情况下会很有帮助。 type Options = { A: boolean; C?: boolean; } | { B: boolean; C?: boolean; }; declare function printLib(options: Options): Promise<any>; 这也确保提供 A 或 B。 C 可以在两个选项中提供,也可以省略。 使用布尔值进行互斥可能不太合适,正如您所指出的,可以使用联合: type Options = { AorB: "A" | "B"; C?: boolean; }; declare function printLib(options: Options): Promise<any>;

回答 1 投票 0

电子商务Order类底层设计

我正在设计购物网站。到目前为止,我陷入了困境,需要一点反馈。假设我有一个订单类定义如下: 类订单{ 付款付款;...

回答 1 投票 0

Restful API:url 中的敏感数据

我想创建一个 API 来获取客户详细信息。 URL 可以是 Get https://../customers/{customerId}。 我的问题是 customerId 很敏感,可以在 url 中传递吗? 如果没有的话,那会是什么...

回答 3 投票 0

用于创建 API 文档/提案的平台独立工具[已关闭]

有哪些工具可用于开发独立于平台的 API 文档? 我正在设计一个建议的 API,并且希望以结构化且易于编辑的方式编写文档。瞧...

回答 1 投票 0

API 弃用警告是否被视为牢不可破的合同?

我有一个 API 即将在主要版本之间移动 - 从 v1.x.y 到 v2.0.0。 它遵循 semver (尽管我认为这并不重要)。 在版本 1.x.y 中,我有几个公共常量...

回答 3 投票 0

API 弃用是否被视为牢不可破的合同?

我有一个 API 即将在主要版本之间移动 - 从 v1.x.y 到 v2.0.0。 它遵循 semver (尽管我认为这并不重要)。 在版本 1.x.y 中,我有几个公共常量...

回答 1 投票 0

dotnet core API 文件夹结构[已关闭]

我正在尝试启动一个新的API,但有很多选项可以被认为是正确的。我只是想知道每个人都建议如何这样做,或者是否有一种我忽略的官方方法......

回答 1 投票 0

如何正确从主函数中的多个函数返回多个错误?

我这里有一个用于创建客户的端点的函数。事情是这样的: 公共函数createCustomer(请求$请求){ // 存储客户的基本信息... $客户=...

回答 1 投票 0

记录 API - /me 端点

我有一个作品集,可以在其中展示我的作品(主要是后端 API 内容,具有最少的 UI 交互),并且目前正在记录 API。我所拥有的是每个项目一个页面以及

回答 1 投票 0

向 Dialogflow Agent 中的特定意图添加新话语

问题很简单,我在Dialogflow-es中开发了一个代理,它已经用N个意图和M个意图的话语进行了训练。 现在,我想自动化训练过程,或者其中的一部分,

回答 1 投票 0

© www.soinside.com 2019 - 2024. All rights reserved.