swagger

Why is the Authorization header missing in requests sent from Swagger UI?

天涯浪子 提交于 2020-07-31 04:50:49
问题 I want to add a documentation to my Node.js API, for this I have a YAML file where I put my definitions, the swagger doc is at localhost:5000/api-doc and working fine. Now I have to add Bearer authorization but Swagger with the following definition: swagger: "2.0" info: version: 1.0.0 title: My API documentation description: > My API documentation host: localhost:5000 basePath: "/v1" schemes: - http securityDefinitions: Bearer: type: apiKey description: "Value: Bearer " name: Authorization in

Why is the Authorization header missing in requests sent from Swagger UI?

橙三吉。 提交于 2020-07-31 04:50:41
问题 I want to add a documentation to my Node.js API, for this I have a YAML file where I put my definitions, the swagger doc is at localhost:5000/api-doc and working fine. Now I have to add Bearer authorization but Swagger with the following definition: swagger: "2.0" info: version: 1.0.0 title: My API documentation description: > My API documentation host: localhost:5000 basePath: "/v1" schemes: - http securityDefinitions: Bearer: type: apiKey description: "Value: Bearer " name: Authorization in

How to generate Map<String, …> with Swagger Codegen?

≡放荡痞女 提交于 2020-07-31 04:13:06
问题 I'm working on an API where we define the API definition in the swagger.yaml file. The API which I am working on returns an output object which contains a map. Output Object : OutputClass public class OutputClass { private Map<String, MapValue> map; } Right now, I used: OutputClass: type: object additionalProperties: $ref: '#/definitions/MapValue' But Swagger Codegen generates the following Java code: public class OutputClass extends HashMap<String, MapValue> implements Serializable { } Is

How to generate Map<String, …> with Swagger Codegen?

旧城冷巷雨未停 提交于 2020-07-31 04:11:48
问题 I'm working on an API where we define the API definition in the swagger.yaml file. The API which I am working on returns an output object which contains a map. Output Object : OutputClass public class OutputClass { private Map<String, MapValue> map; } Right now, I used: OutputClass: type: object additionalProperties: $ref: '#/definitions/MapValue' But Swagger Codegen generates the following Java code: public class OutputClass extends HashMap<String, MapValue> implements Serializable { } Is

How to generate Map<String, …> with Swagger Codegen?

流过昼夜 提交于 2020-07-31 04:11:35
问题 I'm working on an API where we define the API definition in the swagger.yaml file. The API which I am working on returns an output object which contains a map. Output Object : OutputClass public class OutputClass { private Map<String, MapValue> map; } Right now, I used: OutputClass: type: object additionalProperties: $ref: '#/definitions/MapValue' But Swagger Codegen generates the following Java code: public class OutputClass extends HashMap<String, MapValue> implements Serializable { } Is

Swagger 2: use enum reference in query parameter of array type

与世无争的帅哥 提交于 2020-07-31 01:36:10
问题 Can not get how to use reference of string type with enum values in array parameter. I can make reference in items key and it is working, but Swagger produce error: Not a valid parameter definition Web UI generates interface, but it have textarea instead of multiselect box I expected. What is the proper way to do it? My code: swagger: '2.0': paths: /test: get: parameters: - in: origin name: status description: Origin required: false schema: type: array items: $ref: '#/definitions/Origin'

Vue 使用typescript, 优雅的调用swagger API

荒凉一梦 提交于 2020-07-29 11:11:50
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务,后端集成下Swagger,然后就可以提供一个在线文档地址给前端同学。 前端如何优雅的调用呢? 入门版 根据文档,用axios自动来调用 // 应用管理相关接口 import axios from '../interceptors.js' // 获取应用列表 export const getList = (data) => { return axios({ url: '/app/list?sort=createdDate,desc', method: 'get', params: data }) } 这里的问题是,有多少个接口,你就要编写多少个函数,且数据结构需要查看文档获取。 进阶版本 使用typescript,编写API,通过Type定义数据结构,进行约束。 问题: 还是需要手写 优雅版本 swagger 其实是一个json-schema描述文档,我们可以基于此,自动生成。 很早之前,写过一个插件 generator-swagger-2-t , 简单的实现了将swagger生成typescript api。 今天,笔者对这个做了升级,方便支持后端返回的泛型数据结构。 安装 需要同时安装 Yeoman 和 -swagger-2-ts npm install -g

前后端分离时代--Swagger接口文档的配置与使用

眉间皱痕 提交于 2020-07-29 09:00:27
在前后端分离的时代,前端开发人员和后端开发人员的沟通显得尤为重要。如果不能做到及时有效的沟通,可能导致后端开发出来的接口,前端人员无法使用,从而导致后端开发人员不得不返工,甚至延长开发周期。 在了解swagger之前我写好接口都是写一个txt文件,把接口地址,以及传参,返回数据都写好后再给前端人员。这样做是可以做到有效的沟,但还是显得有点麻烦,直到我了解了swagger。 知道swagger的人想必一定知道swagger能够干什么吧,不知道的自行百度。 下面我们就开始准备着手搭建swagger环境。 1、新建一个springBoot项目 项目建成之后写一个controller,保证项目能够正常启动并成功访问。 2、swagger依赖 <!--集成swagger--> <dependency> <groupId>com.spring4all</groupId> <artifactId>swagger-spring-boot-starter</artifactId> <version>1.9.0.RELEASE</version> </dependency> 我用的是speingBoot集成的swagger插件,当然你们也可以去maven找纯净的swagger依赖,但是注意别忘了导入swagger-UI的依赖。 3、依赖导入后我们需要启用swagger。 如果你想尽快使用swagger

基于 abp vNext 和 .NET Core 开发博客项目

不羁岁月 提交于 2020-07-29 05:46:16
系列文章 基于 abp vNext 和 .NET Core 开发博客项目 - 使用 abp cli 搭建项目 基于 abp vNext 和 .NET Core 开发博客项目 - 给项目瘦身,让它跑起来 基于 abp vNext 和 .NET Core 开发博客项目 - 完善与美化,Swagger登场 基于 abp vNext 和 .NET Core 开发博客项目 - 数据访问和代码优先 基于 abp vNext 和 .NET Core 开发博客项目 - 自定义仓储之增删改查 基于 abp vNext 和 .NET Core 开发博客项目 - 统一规范API,包装返回模型 基于 abp vNext 和 .NET Core 开发博客项目 - 再说Swagger,分组、描述、小绿锁 基于 abp vNext 和 .NET Core 开发博客项目 - 接入GitHub,用JWT保护你的API 基于 abp vNext 和 .NET Core 开发博客项目 - 异常处理和日志记录 基于 abp vNext 和 .NET Core 开发博客项目 - 使用Redis缓存数据 基于 abp vNext 和 .NET Core 开发博客项目 - 集成Hangfire实现定时任务处理 基于 abp vNext 和 .NET Core 开发博客项目 - 用AutoMapper搞定对象映射 基于 abp

postman测试WebService及WCF接口

寵の児 提交于 2020-07-28 20:27:10
接到开发接口的任务,写完后不知对错,就想到找一个接口测试工具测一测。接口测试工具有很多,比如Swagger、SoapUI、Jmeter、Postman等,本文着重讲述Postman的安装与使用。 1.Postman的安装 Postman的官方下载地址为https://www.getpostman.com/apps,在这里,你可以根据自己的需求直接下载相应的exe文件,达到一键安装的效果。 2.Postman测试WebService接口 (1)设置url 一般就是访问项目中的asmx文件。 (2)设置请求模式:post (3)设置Header 为防止出现中文乱码,数据编码格式为UTF-8。所以添加Content-Type,值为text/xml;charset=utf-8。 (4)设置Body 勾选raw, 因为WebService通过HTTP协议发送请求和接收结果时,发送的请求内容和结果内容都采用XML格式封装,并增加了一些特定的HTTP消息头,以说明 HTTP消息的内容格式,这些特定的HTTP消息头和XML内容格式就是SOAP协议。这边需要指定传输数据的类型,选择XML(text/xml)格式。 接口定义的请求格式复制到Body中,并且填上必要的参数,例子如下: <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns