Swagger实践和总结

Swagger学习和实践最近安装并使用了一下Swagger-ui.Swagger-editor和Swagger-codegen,感觉还不错. Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.Swagger的目标是对REST API定义一个标准的和语言无关的接口,可让人和计算机无需访问源码.文档或网络流量监测就可以发现和理解服务的能力.当通过Swagger进行正确定义,用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互.与为底层编…

Swagger 实践 <一>

参考 :https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/getting-started-with-nswag?view=aspnetcore-2.2&tabs=visual-studio 1. 新建.net core 的webapi 项目. 2.Install-Package NSwag.AspNetCore 3.ServiceConfig() 中添加 services.AddSwaggerDocument(); 这一步是添加某些…

Swagger 实践 <二>

1. 新建.netCore WebApi 项目(选择Angular).按照上一篇的加上Swage 文档,使http://localhost:11934/swagger/v1/swagger.json 可以访问. 2.新建一个文件夹nswag,里面有3个文件 refresh.bat : "..\node_modules\.bin\nswag" run service.config.nswag,注意修改地址 { "runtime": "Default&…

Abp集成Swagger的最佳实践

1.在项目中添加nuget包 Abp.Web.Api.SwaggerTool 2.在项目Abp模块的DependsOn添加AbpWebApiSwaggerToolModule Run It,启动项目,访问/swagger/ui/index 就打开熟悉的swagger-ui界面,项目中webapi和动态Api的接口都出现了. Abp.Web.Api.SwaggerTool作为swagger的增强包,内部实现了很多有用的功能并提供了一些最佳实践,用户无需在意Swagger的集成问题. 项目源码htt…

Swagger学习和实践

Swagger学习和实践学习了:https://www.cnblogs.com/zxtceq/p/5530396.html swagger 英 [ˈswægə(r)] 美 [ˈswæɡɚ] vi.昂首阔步;夸耀,炫耀 vt.恐吓或欺负(某人) n.昂首阔步;吹嘘,自大 adj.〈口〉漂亮的;时髦的 https://www.cnblogs.com/wer-ltm/p/5776024.html 百度:给项目添加swagger ui https://www.zhihu.com/question/28…

springboot+swagger接口文档企业实践（下）

目录 1.引言 2. swagger接口过滤 2.1 按包过滤(package) 2.2 按类注解过滤 2.3 按方法注解过滤 2.4 按分组过滤 2.4.1 定义注解ApiVersion 2.4.2 添加ApiVersion过滤 2.4.3 新建指定版本号分组的Docket 3. 接口mock数据 3.1 easy-mock安装 3.2 easy-mock + swagger实现mock数据 3.2.1 创建项目并添加swagger地址 3.2.2 自定义模拟数据 4.接口文档离线导出 4.1…

springboot+swagger接口文档企业实践（上）

目录 1.引言 2.swagger简介 2.1 swagger 介绍 2.2 springfox.swagger与springboot 3. 使用springboot+swagger构建接口文档 3.1 springboot示例工程搭建 3.2 引入swagger2与基本配置 3.2.1 添加springfox-swagger依赖 3.2.2 配置swagger 3.2.3 查看swagger自动生成的描述文档 3.3 添加swagger-ui界面交互 4. [企业实践]配置参数化与包过滤 4.…

go实践之swagger自动生成api文档

文章目录 go实践之swagger自动生成api文档 1.安装需要用到的包 2.接口代码支持swagger 3. 生成swagger接口 go实践之swagger自动生成api文档作为一个后端开发,给前端提供api接口是必须的.手动去写文档不是一个程序员的风格.swagger就是一个很好的api文档生成该工具,go当然也支持了.下面看看怎么使用这个工具. 1.安装需要用到的包 root@localhost github.com # go get -u github.com/swaggo/swa…

使用Swagger生成Spring Boot REST客户端（支持Feign）（待实践）

如果项目上使用了Swagger做RESTful的文档,那么也可以通过Swagger提供的代码生成器生成客户端代码,同时支持Feign客户端. 但是经过测试,生成Feign代码和REST客户端有些臃肿. 官方网站:https://github.com/swagger-api/swagger-codegen 参考: https://stackoverflow.com/questions/46019180/how-to-generate-spring-cloud-feign-client-using-…

Hangfire项目实践分享

Hangfire项目实践分享目录 Hangfire项目实践分享目录什么是Hangfire Hangfire基础基于队列的任务处理(Fire-and-forget jobs) 延迟任务执行(Delayed jobs) 定时任务执行(Recurring jobs) 延续性任务执行(Continuations) 与quartz.net对比 Hangfire扩展 Hangfire Dashborad日志查看 Hangfire Dashborad授权 IOC容器之Autofac Recurring…

Swagger - 前后端分离后的契约

前后端分离按照现在的趋势,前后端分离几乎已经是业界对开发和部署方式所达成的一种共识.所谓的前后端分离,并不是传统行业中的按部门划分,一部分人只做前端(HTML/CSS/JavaScript等等),另一部分人只做后端(或者叫服务端),因为这种方式是不工作的:比如很多团队采取了后端的模板技术(JSP, FreeMarker, ERB等等),前端的开发和调试需要一个后台Web容器的支持,从而无法将前后端开发和部署做到真正的分离. 通常,前后端分别有着自己的开发流程,构建工具,测试等.做前端的谁也不会…

Hangfire项目实践

Hangfire项目实践分享 Hangfire项目实践分享目录 Hangfire项目实践分享目录什么是Hangfire Hangfire基础基于队列的任务处理(Fire-and-forget jobs) 延迟任务执行(Delayed jobs) 定时任务执行(Recurring jobs) 延续性任务执行(Continuations) 与quartz.net对比 Hangfire扩展 Hangfire Dashborad日志查看 Hangfire Dashborad授权 IOC容器之Au…

ASP.NET WebAPI 生成帮助文档与使用Swagger服务测试

帮助HELP 要实现如WCF中的Help帮助文档,Web API 2 中已经支持很方便的实现了这一特性 http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages Nuget获得 Install-Package Microsoft.AspNet.WebApi.HelpPage 安装完成后在 Areas/HelpPage/App_Start/HelpPageConfig.cs中启用第一段注释的代码…

spring boot 实践

二.实践一些说明: 项目IDE采用Intellij(主要原因在于Intellij颜值完爆Eclipse,谁叫这是一个看脸的时代) 工程依赖管理采用个人比较熟悉的Maven(事实上SpringBoot与Groovy才是天生一对) 1.预览: (1)github地址 https://github.com/djmpink/springboot-mybatis git : https://github.com/djmpink/springboot-mybatis.git (2)完整项目结构 (3)数…

API 设计: RAML、Swagger、Blueprint三者的比较

API设计工具中常常会拿RAML.Swagger.Blueprint这三种工具进行讨论比较,它们都是用来描述和辅助API开发的,只是它们之间的侧重有所不同. RAML RAML(RESTful API Modeling Language 即 RESTful API 建模语言)是对 RESTful API的一种简单和直接的描述.它是一种让人们易于阅读并且能让机器对特定的文档能解析的语言.RAML 是基于 YAML,能帮助设计 RESTful API 和鼓励对API的发掘和重用,依靠标准和最佳实践从…

【Yii系列】最佳实践之后台业务框架

缘起上面的几章都讲概念了,没有怎么讲到实践的东西,可能会有些枯燥,这很正常的,概念还是需要慢慢啃的,尤其是官网其他的部分,需要狠狠的啃. 什么,你啃不动了?看看官网旁边的那个在线用户吧. 你不啃的时候可是有这么多人在啃知识,如果不想以后被这打击,赶紧学!!!一如当年大学的我,每天夜里都抱着一本<算法导论>在啃一样,自律相当重要. 这一章我就带大伙了解一下前两章的概念有啥用,应用到实际,这是临门一脚,但是,我总是觉得概念的重要性至少要占70%,临门的一脚实践只占30%,望君能体会~ 环境操作…

AspNet Core Api Restful +Swagger 发布IIS 实现微服务之旅（二）

上一步我们创建好CoreApi 接下来在框架中加入 Swagger 并发布到 IIS (1)首先点击依赖项>管理Nuget包 (2)输入 Swashbuckle.aspnetCore 比如: 图中两个Swagger 插件需要我们安装注意:我这里已经安装过显示的是卸载 (3) 在框架中添加Swagger 注解的帮助类 HttpHeaderOperation 下面是我完整的.CS文件 using System; using System.Collections.Generi…

后端开发实践——Spring Boot项目模板

在我的工作中,我从零开始搭建了不少软件项目,其中包含了基础代码框架和持续集成基础设施等,这些内容在敏捷开发中通常被称为"第0个迭代"要做的事情.但是,当项目运行了一段时间之后再来反观,我总会发现一些不足的地方,要么测试分类没有分好,要么基本的编码架子没有考虑周全. 另外,我在工作中也会接触到很多既有项目,公司内部和外部的都有,多数项目的编码实践我都是不满意的.比如,我曾经新加入一个项目的时候,前前后后请教了3位同事才把该项目在本地运行起来:又比如在另一项目中,我发现前端请求对应的Jav…

.Net Core小技巧 - Swagger适配虚拟目录及二级目录

前言随着前后端分离模式与微服务架构的出现,Web API变得越来越重要及普遍.而后出现的网关技术,使开发者更倾向于使用二级/多级目录来暴露Web API,一是暴露的端口更少,方便管理:二是在网关中可以处理一些公共的事务,如认证.但swagger默认是适配根(root)目录的,想要适配二级/多级目录,需要额外处理,同时还要区分开发环境与其它环境.一种思路是在开发环境就让Web API是处于二级目录,此时可以在本机通过nginx和iis虚拟目录来模拟,但这种思路明显略微麻烦.另一种思路是通过配置多…

服务化改造实践 | 如何在 Dubbo 中支持 REST

什么是 REST REST 是 Roy Thomas Fielding [[1]](#fn1) 在 2000 年他的博士论文 [[2]](#fn2) “架构风格以及基于网络的软件架构设计” 中提出来的一个概念.REST 是 RESTransfer 的缩写,翻译过来就是 “表现层状态转化”.REST 就是 Roy 在这篇论文中提出的面向互联网的软件所应当具备的架构风格. 按照 REpresentational State Transfer 的字面意思,可以把应用看成是一个虚拟的状态机,软件提供的不…

.net core实践系列之短信服务-架构设计

前言上篇<.net core实践系列之短信服务-为什么选择.net core(开篇)>简单的介绍了(水了一篇).net core.这次针对短信服务的架构设计和技术栈的简析. 源码地址:https://github.com/SkyChenSky/Sikiro.SMS 为什么需要架构设计有人会问短信服务也要架构设计?不就写个service封装个send方法就得了吗?干嘛还要大动干戈. 如果在单块应用的情况下,以上面的做法是无可厚非的. 然而架构设计解决的是应用复杂度,架构设计的大还是小取决于业…

朱晔的互联网架构实践心得S1E9：架构评审一百问和设计文档五要素

朱晔的互联网架构实践心得S1E9:架构评审一百问和设计文档五要素 [下载文本PDF进行阅读] 本文我会来说说我认为架构评审中应该看的一些点,以及我写设计文档的一些心得.助你在架构评审中过五关斩六将,助你写出能让人收藏点赞的设计文档. 技术架构评审架构评审或技术方案评审的价值在于集众人的力量大家一起来分析看看方案里是否有坑,方案上线后是否会遇到不可逾越的重大技术问题,提前尽可能把一些事情先考虑到提出质疑其实对项目的健康发展有很大的好处.很多公司都有架构评审委员会都有架构评审的流程,做业务的兄弟要…

ASP.NET Core OceLot 微服务实践

1.OceLot中间件介绍在传统的BS应用中,随着业务需求的快速发展变化,需求不断增长,迫切需要一种更加快速高效的软件交付方式.微服务可以弥补单体应用不足,是一种更加快速高效软件架构风格.单体应用被分解成多个更小的服务,每个服务有自己的独立模块,单独部署,然后共同组成一个应用程序.把范围限定到单个独立业务模块功能.分布式部署在各台服务器上. 而Ocelot开发的目标就是使用.NET运行面向微服务/服务的架构,要达到这个目标需要一个统的系统入口点(我们统称为API网关),同时需要与Identit…

使用Swagger 搭建高可读性ASP.Net WebApi文档

一.前言在最近一个商城项目中,使用WebApi搭建API项目.但开发过程中,前后端工程师对于沟通接口的使用,是非常耗时的.之前也有用过Swagger构建WebApi文档,但是API文档的可读性并不高.尤其是没有传入参数和传出结果的说明,导致开发人员沟通困难.在园子里看到一篇关于对Swagger优化的文章,有很大的改进.解决了传入参数,API分区域筛选等问题, 非常感谢博主简玄冰. 不过实践之后,发现还有些问题未解决: 接口返回的对象,没有汉化说明接口授权参数(token)未统一传入所以,决…

.net core实践系列之短信服务-Sikiro.SMS.Api服务的实现

前言上篇<.net core实践系列之短信服务-架构设计>介绍了我对短信服务的架构设计,同时针对场景解析了我的设计理念.本篇继续讲解Api服务的实现过程. 源码地址:https://github.com/SkyChenSky/Sikiro.SMS 此服务会使用.NET Core WebApi进行搭建,.NET Core WebApi基础原型就是RESTful风格,然而什么叫RESTful呢. REST API简介 REST Representational State Transfer的缩写…

.net core实践系列之短信服务-Api的SDK的实现与测试

前言上一篇<.net core实践系列之短信服务-Sikiro.SMS.Api服务的实现>讲解了API的设计与实现,本篇主要讲解编写接口的SDK编写还有API的测试. 或许有些人会认为,SDK的编写可以不需要,既然已经用了RESTful web服务与Swagger提供的接口描述,只要选择合适的接口调用框架,找到对应Swagger文档按需调用即可. 这个我赞同,特别在微服务架构下使用了API网关与服务发现.因此本篇也是借用编写SDK来模拟在客户端使用接口框架调用,并增加负载测试的讲解,供需要的…

Abp项目构建、swagger及代码生成器

前段时间在学习abp,在配置swagger时踩了不少坑,特此整理一下,方便同行参考.幸运的是又发现了神奇的代码生成器,分享下亲身经验. 觉得此博客非常有用的朋友可以在右侧赞助打赏下,非常感谢大家支持. 推荐博客 1. Abp项目实践推荐参照大神角落的白板报的系列博客,比较新,并且是亲身体验. http://www.cnblogs.com/wer-ltm/p/6824716.html 2. Abp源码整体原理结构.类关系图等参看大神Hk Zhang http://www.cnblogs.com/1…