openapi-specification

从零开始搭建前后端分离的NetCore2.2(EF Core CodeFirst+Autofac)+Vue的项目框架之十二Swagger(参数)使用二

我与影子孤独终老i 提交于 2020-08-15 07:27:10
   引言   在 上一篇 中提到了 Swagger 的基本使用,仅限于没有参数,没有验证的那种api文档生成,那么这篇就连接上篇继续,在一般具有安全性、权限等验证的接口上,   都会在header/url中加上请求者的秘钥、签名等,当然也有可能添加到body等其它地方, Swashbuckle.AspNetCore 都支持这些写法。    如何使用 -- 下面将介绍两种使用方式 两种方式参数设置到何处都是在 In 属性 上,属性对于值如下: 参考 https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameter-object query: 参数字段值对应放在url中 header: 参数值对应放在header param中 body: 参数对应放到请求体中 path: 参数应该对应放到请求路径 // 具体貌似没用 formData: 参数对应放到请求表单中    第一种:将一个或多个参数保护API的“securityDefinitions”添加到生成的Swagger中。 这种是直接在文档的右上方添加一个 Authorize 按钮,设置了值后,每一个请求都会在设置的位置上加上相应的值,在 上一篇随笔中的 ConfigureServices 方法中, 对应位置 services

浅析如何在Nancy中使用Swagger生成API文档

时光总嘲笑我的痴心妄想 提交于 2020-08-08 16:55:04
前言 上一篇博客介绍了使用Nancy框架内部的方法来创建了一个简单到不能再简单的Document。但是还有许许多多的不足。 为了能稍微完善一下这个Document,这篇引用了当前流行的Swagger,以及另一个开源的 Nancy.Swagger 项目来完成今天的任务! 注:Swagger是已经相对成熟的了,但 Nancy (2.0.0-clinteastwood)和 Nancy.Swagger (2.2.6-alpha)是基于目前的最新版本,但目前的都是没有发布正式版,所以后续API可能会有些许变化。 下面先来简单看看什么是 Swagger 何为Swagger The World's Most Popular Framework for APIs. 这是Swagger官方的描述。能说出是世界上最流行的,也是要有一定资本的! 光看这个描述就知道Swagger不会差!毕竟人家敢这样说。当然个人也认为Swagger确实很不错。 通过官方文档,我们都知道要想生成Swagger文档,可以使用YAML或JSON两种方式来书写,由于我们平常写程序用的比较多的是JSON! 所以本文主要是使用了JSON,顺带说一下YAML的语法也是属于易懂易学的。 既然是用JSON书写,那么要怎么写呢?这个其实是有一套规定、约束,我们只要遵守这些来写就可以了。详细内容可以参见 OpenAPI