Tag: swagger

如何使用swagger-ui模块在我的MEAN堆栈项目中显示Swagger JSON文件？: 我是NodeJS和AngularJS的新手，所以我可能会接近完全错误，但值得问… 我正在尝试使用swagger-ui Node模块以交互式的Swagger-ish风格显示我的API文档。我想在我的NodeJS应用程序中通过传入我自己的Swagger JSON文件（在public/assets/my-swagger.json ）执行此操作。我假设我可以做这样的事情： angular.module('SwaggerCtrl', []).controller('SwaggerController', function($scope) { $scope.swagger = new function() { var swaggerUi = new SwaggerUi({ url: '../../assets/my-swagger.json', dom_id: "swagger-ui-container" }); swaggerUi.load(); }; }); 从https://www.npmjs.com/package/swagger-ui#swaggerui取得。然后在我的swagger.html我会做这样的事情： <div class="jumbotron text-center"> <h1>Swagger</h1> <p>{{ swagger }}</p> <div id="swagger-ui-container"></div> </div> 但是，当我去http：// localhost：8080 / swagger ，我得到ReferenceError: SwaggerUi is not defined我的控制台上ReferenceError: SwaggerUi is not defined错误信息。 […]

使用严格模式进行Swaggervalidation: 我正在使用Swagger工具和Swagger Spec 2.0来validation我的Node JS服务中的请求正文。问题是带附加属性的JSON通过validation，并影响服务的内部逻辑。有效的JSON示例： { "name": "proper object", "requiredProperty": "some value" } 仍然有效的JSON的例子，我想阻止： { "name": "proper object", "requiredProperty": "some value", "additionalProperty": "should not be here!!!" } 是否有可能使用严格的模式，将失败的请求包含额外的属性？

如何整合与koa和joi的招摇？: 我正在编写基于KOA框架的节点API。为了validation，我更喜欢Joivalidation，并添加一个中间件。现在我想整合Swagger 。但我认为我编写了两次相同的代码部分（请求数据validation部分，一个在joivalidation中，另一个在swagger yaml文件中）。请给我举一个例子，或者把swagger，koa和joi结合起来的最好方法。

我如何把一个node.js swagger项目放入lambda？: 我一直在关注scotch.io中的一个教程，关于在使用swagger-node的节点中创build一个swagger API，我已经决定使用swagger-express-mw 。一切看起来很简单，很简单。但是我遇到了一个绊脚石 – 我怎么把我刚刚创build的API（或者至less是hello_world ）放到AWS Lambda上（我觉得Swagger的工作非常好）。我build立了一个AWS账户，并且在一些路线上玩过 – 但是我正在努力查看我的代码/工作stream程。任何人有任何信息将是伟大的。我已经做了一个合理的谷歌，但我看不出任何直接的。谢谢大家，祝你有美好的一天:)

从hapi-js路由自动生成swagger.yaml: 我正在使用一个相当复杂的使用hapiJS编写的NodeJS API。 api使用hapi-swagger npm模块来生成API文档。我现在正在研究如何将Amazon API Gateway与此api集成，以提供身份validation/请求限制等。要创build一个Amazon Gateway API，似乎需要提供一个swagger定义。我的问题是，我如何产生这个swagger定义？我假设必须有办法从hapi-swagger自动执行此操作，但是我一直无法find它。

Swagger中的多个项目的数组: 所以我用nodejs创build了一个用户端点来添加一个用户到数据库，并且为了使用swigger编辑器的api文档，我完全不熟悉它。我想要做的就是添加一个用户login，密码，头像，但该用户有多个angular色，我想添加到数据库中，我已经做了大拇指在YAGL文档编辑器是这样的 /users/add: post: description: '' operationId: AddUser parameters: – description: The user login in: formData name: user required: true type: string – description: The user password in: formData name: password required: true type: string – description: The user name in: formData name: username required: true type: string – description: The user avatar in: formData […]

Swaggerpath的特定安全性: 我有一个Node.js API，我想在其中添加swagger文档。客户通过智威汤逊授权，所以我添加到安全： securityDefinitions: UserSecurity: type: apiKey description: User is logged in in: header name: Authorization 比我可以添加到不同的path告诉客户端，要做到这一点，你需要login。 /user/{userId} get: security: – UserSecurity: [] 但是，如何添加更具体的安全约束呢？就像用户只能以该用户身份login时才能编辑configuration文件。或者，如果用户具有superadmin状态，或者如果他是董事会的董事会成员，则用户可以编辑评论，评论发布在OR上或作为创build此评论的用户login。

如何绑定一个辅助存根到超级特权的swagger-node？: 我用express来使用Swagger Node ，并初始化了框架项目。 Swagger project create hello-world 然后在hello-world/api/controllers/hello_world.js我添加了一个小小的修改，需要一个助手hello_helper.js并调用它的函数helloHelper.getName() 。 'use strict'; let helloHelper = require('../helpers/hello_helper'); var util = require('util'); module.exports = { hello: hello }; function hello(req, res) { var name = req.swagger.params.name.value || helloHelper.getName(); var hello = util.format('Hello, %s!', name); res.json(hello); } 你好世界/ API /助理/ hello_helper.js 'use strict'; module.exports = {getName: getName}; function getName() […]

Swagger UI不加载昂首阔步的JSON: 我在swagger-editor的帮助下做了api文档。现在我想在swagger-ui的帮助下看到它的graphics。我在这里部署了我的json https://powerful-escarpment-92284.herokuapp.com/swagger.json 现在，当我试图访问它，然后我得到一个错误无法加载规范。

根据Swagger API定义来检查JSON负载是否有效: 我正在使用swagger来定义我的API和API网关来承载这个API。我发现下面的lib（请参阅这里）将我的API定义导入到AWS，并自动创buildAPI（模型，端点等）。这个很酷。但是，它无法validation基于模型的请求（在Swagger定义中定义）。这意味着您可以发送没有必填字段的JSON负载。我不想编写node.JS代码来检查格式，因为模式更新不会太简单。我想知道是否有可能检查JSON有效载荷是否与在swagger（在“definitions”部分中定义的对象）中定义的特定types的对象兼容。如果可能的话，它将允许我只更新我的大摇大摆的定义。谢谢，罗曼。