swagger

JApiDocs 动态生成接口文档,并解析java 源码中的注释

痞子三分冷 提交于 2020-08-10 20:08:30
最近碰到一个有趣的开源项目: JApiDocs 地址: https://gitee.com/yeguozhong/JApiDocs 1、介绍 JApiDocs 是一个符合 Java 编程习惯的 Api 文档生成工具。最大程度地利用 Java 的语法特性,你只管用心设计好接口,添加必要的注释,JApiDocs 会帮你导出一份漂亮的 Html 文档,并生成相关的 Java 和 Object-C 相关数据模型代码,从此,Android 和 IOS 的同学可以少敲很多代码了,你也不需要费力维护接口文档的变化,只需要维护好你的代码就可以了。 实际使用中,你的原先代码,可能如下: /** * Get User List * @param listForm */ @RequestMapping(path = "list", method = {RequestMethod.GET, RequestMethod.POST} ) public ApiResult<PageResult<UserVO>> list(UserListForm listForm){ return null; } 此时,你的代码不用改动 (仅仅需要引入依赖jar,和简单的配置),不用像swagger一样额外通过注解的形式,来给该接口添加说明,该 JApiDocs 会自行给该接口添加接口说明和字段说明。 换言之,该

基于.NetCore3.1系列 —— 使用Swagger导出文档 (补充篇)

主宰稳场 提交于 2020-08-10 08:54:04
前言 在上一篇 导出文档 番外篇中,我们已经熟悉了怎样根据json数据导出word的文档,生成接口文档,而在这一篇,将对上一篇进行完善补充,增加多种导出方式,实现更加完善的导出功能。 回顾 1. 获取Swagger接口文档的Json文件 2. 解析Json文件数据填充到Html的表格中 3.根据生成的html转work文档 功能 开始 根据生成的html转work文档 /// <summary> /// 静态页面转文件 /// </summary> /// <param name="html"> 静态页面html </param> /// <param name="type"> 文件类型 </param> /// <param name="contenttype"> 上下文类型 </param> /// <returns></returns> public Stream SwaggerConversHtml( string html, string type, out string contenttype) { string fileName = Guid.NewGuid().ToString() + type; // 文件存放路径 string webRootPath = _hostingEnvironment.WebRootPath; string path =

SpringBoot2.0+Shiro+MyBatisPlus权限管理系统

断了今生、忘了曾经 提交于 2020-08-10 07:28:11
项目描述 Hi,大家好,今天分享的项目是《SpringBoot+Shiro权限管理系统》,这是一个SpringBoot+Layui后台管理系统,使用Shiro安全框架,加入访问权限,对不同角色有不同的访问权限,其他管理可以依据情况添加上去。相信无论作为企业级应用,私活开发脚手架或者权限系统构建学习,该项目都会是一个不错的选择。本系统模块如下: 用户管理 管理用户数据 用户分角色 角色管理 管理角色数据 使用ztree实现角色分配权限 权限管理 管理权限数据 实现了SwaggerAPI文档 日志监控系统 SQL监控 数据源管理 SQL防火墙 URL监控 Session监控 技术栈 SpringBoot2.0+Shiro+MyBatisPlush+LayUI+Swagger2.0 运行环境 IDEA+Tomcat8以上+MySQL5.5以上 项目截图 下载方式 先点在看,再取源码哦,关注 一点教程 公众号,回复关键词 xz202004 就可以获得下载链接和提取码。如部署过程有问题,后台回复 加我 添加小助手微信。 欢迎关注我的公众号::一点教程。获得独家整理的学习资源和日常干货推送。 如果您对我的系列教程感兴趣,也可以关注我的网站: yiidian.com 来源: oschina 链接: https://my.oschina.net/u/3038200/blog/4355059

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

僤鯓⒐⒋嵵緔 提交于 2020-08-10 05:29:48
上一篇文章( https://www.cnblogs.com/meowv/p/12961014.html )集成了定时任务处理框架Hangfire,完成了一个简单的定时任务处理解决方案。 本篇紧接着来玩一下AutoMapper,AutoMapper可以很方便的搞定我们对象到对象之间的映射关系处理,同时abp也帮我们是现实了 IObjectMapper 接口,先根据官方文档: https://docs.abp.io/zh-Hans/abp/latest/Object-To-Object-Mapping ,将AutoMapper添加依赖到项目中。 在 .Application 层模块类中添加 AbpAutoMapperModule 模块依赖。 //MeowvBlogApplicationModule.cs using Meowv.Blog.Application.Caching; using Volo.Abp.AutoMapper; using Volo.Abp.Identity; using Volo.Abp.Modularity; namespace Meowv.Blog.Application { [DependsOn( typeof(AbpIdentityApplicationModule), typeof(AbpAutoMapperModule), typeof

推荐一款技术人必备的接口测试神器:Apifox

拥有回忆 提交于 2020-08-10 04:50:10
1. 背景 作为互联网行业技术从业者,接口调试是必不可少的一项技能,通常我们都会选择使用 Postman 这类工具来进行接口调试,在接口调试方面 Postman 做的确实非常出色。当然除了Postman,还有它的老婆: Postwoman 也同样很出色,公号之前有发表过一篇关于它老婆 Postwoman 使用的文章,详细可阅: 推荐一款 Postman 的开源替代品: Postwoman 但是在整个软件开发过程中,接口调试只是其中的一部分,还有很多事情 Postman 是无法完成的,或者 无法高效完成 ,比如:接口文档定义、Mock 数据、接口自动化测试等等。 今天给大家推荐的一款神器: Apifox ,它是集: 接口文档管理 、 接口调试 、 Mock 、 接口自动化测试 于一体的。有的读者咋一看,会觉得和 YAPI 有点类似,但两者在功能特色上,只能说是各有千秋的。 细心的读者,会发现文章,正文干货还没有开始,就已经为大家推荐了三款效率神器: Apifox、Postwoman、YAPI。 2. 聊一聊接口管理的现状 对于接口管理的现状来说,目前行业大部分采取的解决方案有如下几种: 使用 Swagger 管理接口文档。 使用 Postman 调试接口。 使用 RAP或Easy Mock来进行 Mock 数据。 使用 JMeter 做接口自动化测试。 上述的接口管理手段,咋一看

Net Core: Swashbuckle Set operationId Automatically on to Controller Action Method

喜你入骨 提交于 2020-08-10 03:37:53
问题 We are trying to override Swashbuckle/Swagger IO CodeGen naming conventions, when its creating Angular API Service Proxies, for existing 500+ controllers and the corresponding methods. Currently linking Net Core 3 APIs with Angular Typescript. https://stackoverflow.com/a/58567622/13889515 The following answer works: [HttpGet("{id:int}", Name = nameof(GetProductById))] public IActionResult GetProductById(int id) // operationId = "GetProductById"' [HttpGet("{id:int}", Name = "GetProductById")]

俺咋能看懂公司前端项目?

两盒软妹~` 提交于 2020-08-10 02:40:12
​● ● ● 大家好, 我是一名刚步入社会的有志青年开发者。 在校学了三年的后端开发,没想到刚步入公司干起了前端工作,华丽的转变让我有点猝不及防,谁让我辣么优秀! 趁 着头 发茂密,让我们步入正题! 很有幸进入公司就参与了项目的开发,项目的前端是采用的Vue和Element框架,我刚拿到公司封装之后的Vue的脚手架翻了翻,瞬间感觉对不起老大,我不配当你小弟,请原谅我猜不透你的心思。何以解忧,唯有度娘。 熟悉了那么一个星期,让我最钦佩的是调用后端接口这块封装的代码,使用的时候仿佛像在写java调用类的静态方法一样,就像这样AppController.create,有人肯定会问你的参数是不是让狗吃了,兄台白慌,听哥说完,你不看完我咋提高阅读量,下面请不要随地吐痰。 作为前端开发,避免不了与后台接口打交道,经常要去接口文档或者访问swagger网址查看接口详情,就导致代码和查看接口之间来回切换。年轻手速快记性好的请随意。 接口联调的时候如何一眼就能知道该调哪个接口和传哪些参数很重要,有助于开发的效率。如果有一种将接口信息植入到前端项目里,调用的时候它还能提示你调哪个方法,参数还能一目了然的方式,那就美滋滋了。然而在这里,你赚大了。 框 架的灵魂在于它的设计 思想,在这里仅传授设计思想,不然就像我最近写论文一样半天憋不出俩字写个猴年马月。 唉 前面写的有点啰嗦了, 下面那就开始掉头发吧。

基于SpringCloud的微服务架构实战案例项目

╄→гoц情女王★ 提交于 2020-08-10 00:06:30
QuickStart 基于SpringCloud体系实现,简单购物流程实现,满足基本功能:注册、登录、商品列表展示、商品详情展示、订单创建、详情查看、订单支付、库存更新等等。 github源码地址: https://github.com/backkoms/simplemall 每个业务服务采用独立的MYSQL数据库,初期考虑用到如下组件: 服务注册、发现: eureka 配置管理:spring config , spring security 集群容错: hystrix(待实现) API网关: zuul(待实现) 服务负载:feign+ribbon api文档输出:swagger2 代码简化:lombok 消息队列:rabbitmq 分布式锁: redis (待实现) 链路跟踪:spring cloud sletuh ->zipkin 安全认证:oauth2/JWT(待实现) 服务监控:spring-boot-admin 各模块介绍 模块名称 端口 简介 admin-server 9002 服务监控中心,监控所有服务模块 conf-server 9004 分布式配置中心,结合spring-security/rabbitmq同时使用 eureka-server 9003 服务注册中心,提供服务注册、发现功能 sleuth-server 9001

.Net Core WebApi(二)在Windows服务器上部署

强颜欢笑 提交于 2020-08-09 22:48:02
  上一篇学习到了如何简单的 创建.Net Core Api和Swagger使用 ,既然写了接口,那么就需要部署到服务器上才能够正式使用。服务器主要用到了两种系统,Windows和Linux,.Net和Windows都是属于微软爸爸的,那么这一篇就先从部署到Windows服务器系统开始吧。 一、准备服务器   首先,我们需要一台装了Windows Server的云服务器,但是我没有。那么,到这里就结束了。(╮( ̄▽ ̄)╭开玩笑的)   言归正传,我们没有云服务器怎么办,那当然是要买一台了。有人会说有点贵,确实,便宜的一个月都好几十,不过那是在连续不间断使用的情况下的,既然我们是学习那么就不需要一直用,所以我们只需要买【按量计费】的就行了。   到阿里云购买服务器却发现:   嗯,要100元才能买,果断转战其他平台。   然后发现腾讯云没有这个限制,果然腾讯亲民啊。(疯狂暗示)   经过我一系列的操作,发现成都地区的最便宜,一个小时只需要2毛钱,比去网吧上网便宜多了。(不要告诉我你买不起,抢QQ红包都能抢够,更何况是花在学习上的钱,那叫投资(~ ̄▽ ̄)~ )   按照图下,选择【按量计费】,选地区(我用的最便宜的成都地区),选机型(最便宜的,够用)。   选择公共镜像,【Windows Server 2012 R2 数据中心版 64位中文版】,当然如果你英语好,也可以选英文版的。  

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

萝らか妹 提交于 2020-08-09 20:38:08
系列文章 基于 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