问题标签 [raml]

我想使用 RAML 来描述使用 OAuth2 的 API

有没有人有一个解决方案或示例可以用来与我自己的 api 的 RAML 进行比较？

如何在 DELETE 操作期间获取请求正文？Mule 消息有效负载是 URI，而不是客户端发送的 JSON 文档。

一点背景

我在 RAML 中定义了 POST、PUT 和 DELETE 操作，并使用 APIKit 生成了我的 Mule 项目。REST Web 服务的调用者没有主键，所以它不能放在 URI 中（我假设这是 DELETE 的用途）。然而，客户端确实有另外两条数据，服务层使用它们来查找主键并删除数据库中的记录。

我想我可以为 DELETE 操作创建两个查询参数，但我更愿意在正文中传递一个 JSON 文档。

我一直在考虑一个文档工具，用于为要在多个客户端中使用的 Web 服务构建后端，以及 OAuth 和多个修订的可能性。我已经知道养蜂场了，但做了一些研究，我发现了其他相当不错的解决方案，并承诺有利可图。

RAML 似乎承诺良好的代码生成和 api 可重用性。但它似乎无法创建模拟服务器。而且我不明白为什么 apiblueprint 不能用于为 REST API 生成客户端库和服务器端骨架。

对我们来说，最好的用例是 API 文档，可以自动生成用于使用服务的客户端 iOS/Android/wp/js 库以及提供框架以编写代码的 node express/restify 应用程序。连同 api 测试和负载测试。

RAML/Swagger/Apiary 中的哪个解决方案最适合这个？

我在各种服务中大量使用了 Angular 中的 $http 模块，但希望将它与 Mulesofts RAML 解析器集成。这将使我不必为了适应 RAML 规范而更新 angular 的某些部分。

有人做过吗？需要哪些步骤？

如果这是不可能的，我想只使用 $resource 模块来获取 RAML 中描述的 REST 资源并没有太多的工作。

我试图浏览 RAML 的所有教程，我非常兴奋。

我发现大多数可用的在线资源，但我不明白为什么，当我设置所有内容并生成流时，然后我在本地运行它作为骡子应用程序，当我指向 localhost:8081/api/console/ 我得到一个 huuuuuuuge json 响应，但不是此处描述的 UI 。

我正在用 RAML 编写 API 规范，并且想知道是否可以引用 uri 参数来创建动态 mime 类型。类似的东西

我正在 API 设计器中编写一些 RAML，并且我有以下代码：

解析器抛出错误，/{slug}因为它认为我正在尝试将其用作get:方法的属性。但是，/{slug}需要缩进以使其从属于/tags.

RAML（或 YAML，因为 RAML 应该是 YAML 的一个实例）中有没有办法标记地图的结尾？或者你有什么其他建议吗？

Is it possible to reference a json block from within the same rAML file for request/response examples? From the spec there does not appear to be a way to do this other than having an external file; but I'd like to have the example and schema live next to each other if possible. Much like how you can use schema:

我正在使用 RAML 和 API Manager 处理 Mule 项目。按照此处给出的程序

AM 使用 API Manager 来处理与特征相关的服务，例如

• 简单的安全管理器，
• OAuth 2.0 提供者和
• OAuth 2.0 访问令牌强制执行。

我有一个单独的重定向流程，它执行以下操作

1. 将“状态”设置为 302

2. 将“位置”设置为下面的 URL

   http://localhost:8081/org/oauth/token?grant_type=authorization_code&&client_id=53a406c3e4b0624da8246eed&client_secret=myclientsecret&code=#[message.inboundProperties.code]&redirect_uri=http://localhost:8081/raml-api-with-oauth/redirect

一切顺利，直到这里。

但是当我尝试点击访问令牌的 url 时，我看到一条消息

{"error":"unauthorized_client","error_description":""}

总结我的问题：

1. 请帮助我完成“OAuth dance”程序
2. 我如何设置与 API 的有效合同，以促进 OAuth 舞蹈所需的 clientId 和 clientSecret 的通信。

请帮助我哪里出错了。

RAML 代码：

Where do i define valid set of username and passwords for authentication using RAML.

Here is the RAML code i use.