Tag: swagger ui

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 […]

用户和angular色授权在swigger api express中

人 在我现有的api上,我已经拥有使用承载安全性的用户authentication。 使用http头api_key和后来的令牌。 我的问题似乎是我有不同的终点,只需要根据angular色消耗。 例如,发布一个新用户: POST user should only be authenticated to user with admin role. 我在这里看了一下swagger规范,但没有我能find他们的docuemation和谷歌以及。 请给我一些脑筋急转弯的想法? 下面是我在nodejs和express中的访问validation代码。 swaggerTools.initializeMiddleware(swaggerDoc, function (middleware) { // Interpret Swagger resources and attach metadata to request – must be first in swagger-tools middleware chain app.use(middleware.swaggerMetadata()); app.use(middleware.swaggerSecurity({ Bearer: function(req,def,apiKey,next){ apiKey= apiKey.slice(7) debug("token check",def,apiKey) var ok=checkToken(apiKey) if(ok) { req.user=ok debug('Token is […]

Swagger UI不加载昂首阔步的JSON

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

在部署时获得空path的关键。 本地正在工作

我正在使用swagger-jsdoc 。 一切似乎都很好,我得到的JSON,直到我使用localhost ,当我使用实时url,它没有给我什么path键即。 { "info": { "title": "App API", "version":"0.0.0", "description":"Server API documentation" }, "host":"something.com", "basePath":"/", "schemes":["https"], "swagger":"2.0", "paths":{}, "definitions":{}, "responses":{}, "parameters":{}, "securityDefinitions":{}, "tags":[] } 这就是我现场直播的内容。 相同的代码在localhost/swagger.json上工作,但不在https://something.com/swagger.json var swaggerJSDoc = require('swagger-jsdoc'); var swaggerOptions = { swaggerDefinition: config.swaggerDefinition || { info: { // API informations (required) title: 'Hello World', // Title (required) version: '1.0.0', // […]

如何在Azure Easy API中启用Swagger UI

我正在使用Azure应用程序服务,并已经为我的手机设置了简易表的Easy API用于API后端。 我想知道如何设置Azure应用服务的Swagger UI。 当我尝试导航到API(例如https://xxxxxx.azurewebsites.net/swagger/ui )时,声明“要访问交易者UI,您必须通过添加swagger来支持swagger支持:true对您的configuration和安装swagger-ui npm模块“ 当你没有API的源代码(它是使用Easy API自动创build的)时,你如何精确添加swagger-ui npm?

Swagger – 更改项目目录

我在我的工作区内的根目录内创build了新的项目(nodeJS),并在一段时间后,我想分开项目的客户端和服务器端。 为此,我在项目的根目录中创build了两个文件夹(服务器和客户端),并将所有文件和目录移动到适当的文件夹中。 之后,我无法启动服务器,因为它说Swagger找不到swagger.yaml文件(我将它移动到服务器文件夹) { Error: ENOENT: no such file or directory, open 'C:\Users\User\Documents\movieCollection\api\swagger\swagger.yaml' at Error (native) at Object.fs.openSync (fs.js:634:18) at Object.fs.readFileSync (fs.js:502:33) at C:\Users\User\AppData\Roaming\npm\node_modules\swagger\lib\commands\project\project.js:283:44 at findProjectFile (C:\Users\User\AppData\Roaming\npm\node_modules\swagger\lib\commands\project\project.js:308:14) at readProject (C:\Users\User\AppData\Roaming\npm\node_modules\swagger\lib\commands\project\project.js:268:3) at Command.edit (C:\Users\User\AppData\Roaming\npm\node_modules\swagger\lib\commands\project\project.js:240:3) at Command.<anonymous> (C:\Users\User\AppData\Roaming\npm\node_modules\swagger\lib\util\cli.js:167:27) at Command.listener (C:\Users\User\AppData\Roaming\npm\node_modules\swagger\node_modules\commander\index.js:301:8) at emitTwo (events.js:106:13) errno: -4058, code: 'ENOENT', syscall: 'open', path: 'C:\\Users\\User\\Documents\\movieCollection\\api\\swagger\\swagger.yaml' } 我试图编辑节点服务器的config文件夹内的default.yaml文件,但问题仍然存在。 有没有办法将swagger项目configuration指向新的(目录 – >服务器文件夹)? […]

在node.js上大举的可空字段

我花了一大堆时间试图find解决scheme,在Node.JS中创buildswagger文档。 主库是swagger-node,在其中创build一个swagger yaml文件,然后将控制器添加到其中。 它会自动在您的应用程序中提供swagger ui文档,并根据您在yaml中指定的模型对请求和响应进行validation。 这是整洁的,但是我有一个要求,我想明确地能够返回或接受null作为一个值的一些领域,例如: { id: 123, description: "string", date_sent: null } 我不想删除date_sent键,我想明确说明它为空。 swagger规范不支持anyOf这是我相信JSON模式通常如何做。 我想知道是否有解决方法? 也许某些库可用于节点,您可以添加一个x-nullable供应商特定标志,或某种方式指定我的不需要的字段应该都是可以为空的。 我将不得不自己写一些需要我的swagger文件,然后在validation器中间件运行之前修改它,或者有人可以build议一些解决方法吗?

swagger-node-express:如何从swagger-ui上传文件?

看到这个Q&A,但没有相同的结果作为OP 如何张贴文件在大招? 在我的swagger-node-express API中使用这个规范 exports.saveFile = { 'spec' : { "description" : "Saves a file to filesystem", "path" : "/uploads/file", "notes" : "", "summary" : "POST a file to storage", "method" : "POST", /* "supportedContentTypes" : [ 'multipart/form-data' ], */ "produces":[ "application/json" ], "consumes":[ "multipart/form-data" ], "params" : [{ "name": "File", "description": "The file to […]