swagger

netcore 3.1 自定义404逻辑

主宰稳场 提交于 2020-08-05 02:05:01
404页面,以前在netframework里,需要在iis上配置,或者在web.config里配置,在netcore mvc里,则可以用中间件来实现,非常简单!(别被“中间件”这个名词吓坏了)!!! 直接上代码, 1、首先创建一个404页面,比如: [Route( " error/404 " )] public IActionResult Error404() { return View(); } 上面的是Action,再创建对应的View页面,View页面我就不贴代码了。 2、写中间件,StartUp类的Configure方法里, 只要一句话: // 404 app.Use( async (context, next) => { await next.Invoke(); if (context.Response.StatusCode == 404 ) { // 也可以定义为其他地址(沐雪微商城) context.Response.Redirect( " /error/404 " ); } }); // 404 end 具体的代码如下: public void Configure(IApplicationBuilder app, IWebHostEnvironment env, IHostApplicationLifetime applicationLeftTime) { if

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

北慕城南 提交于 2020-08-04 20:25: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

SpringBoot中优雅的使用Swagger2

给你一囗甜甜゛ 提交于 2020-08-04 19:07:41
前言   Spring Boot 框架是目前非常流行的微服务框架,我们很多情况下使用它来提供 Rest API。而对于 Rest API 来说很重要的一部分内容就是文档,Swagger 为我们提供了一套通过代码和注解自动生成文档的方法,这一点对于保证 API 文档的及时性将有很大的帮助。本文将使用 Swagger 2 规范的 Springfox 实现来了解如何在 Spring Boot 项目中使用 Swagger,主要包含了如何使用 Swagger 自动生成文档、使用 Swagger 文档以及 Swagger 相关的一些高级配置和注解。 Swagger 简介 Swagger 是一套基于 OpenAPI 规范构建的开源工具,可以帮助我们设计、构建、记录以及使用 Rest API。Swagger 主要包含了以下三个部分: Swagger Editor:基于浏览器的编辑器,我们可以使用它编写我们 OpenAPI 规范。 Swagger UI:它会将我们编写的 OpenAPI 规范呈现为交互式的 API 文档,后文我将使用浏览器来查看并且操作我们的 Rest API。 Swagger Codegen:它可以通过为 OpenAPI(以前称为 Swagger)规范定义的任何 API 生成服务器存根和客户端 SDK 来简化构建过程。 为什么要使用 Swagger

如何设计好的RESTful API

风流意气都作罢 提交于 2020-08-04 13:02:56
现状 现阶段的开发模式多以前后端分离形式存在,前后端开发人员需要通过大量 API 来进行数据交互,如果在交互过程中前后端人员经常遭遇如下问题:  前端人员不能快速理解接口字段含义及接口字段变化  后端人员想复用某些接口,但是不能快速从接口 URL 的定义中明确该接口的含义,需要进一步读代码确认  URL中的英文单词使用五花八门,搜索某个接口不知道具体的关键字  请求方法动词如 POST GET 随意使用  完成当前业务接口对接,前端人员经常会询问下一步业务流程的接口定义在哪里,对接形式是什么样的 以上只是前后端人员通过接口交互的一小部分问题,这些问题就好比"牙痛",不致命,但是在整个软件开发的生命周期内,天天"牙痛”是很要命的, 需要解决上述的问题,需要前后端人员都能认识与了解接口设计规范的重要性。 什么是REST 在 2000 年,Roy Fielding 提出 Representational State Transfer (REST) 的概念,中文翻译过来"表述性状态传递",感兴趣的朋友可以去维基百科看看原始概念,乍一看是一个挺抽象的概念,但其实,这个概念就像交通灯规则一样简单,就看如何看待相关规范. 当我们谈及 RESTful 设计规范,多数人能了解设计的大原则,但是不了解小细节,而对这些细节的了解与否,是能否治好"牙痛病"的关键 REST术语介绍

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

人盡茶涼 提交于 2020-08-04 11:52:56
系列文章 基于 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

关于接口设计的一些反思

淺唱寂寞╮ 提交于 2020-08-04 09:11:01
许久没有产出了,今天看了掘金上的一篇关于接口设计的文章,因此有感谈谈自己在项目开发中与后的一些想法和反思。 参考: 一篇来自前端同学对后端接口的吐槽 以使用者的视角开发接口 对于RESTful风格的前后端分离式开发,接口的设计应该从何种视角出发呢?一般情况下,后端开发人员(我)的想法是: 想要实现这个功能,我需要返回哪些数据? 我要怎样划分不同的API? 当两个接口返回的数据有重复的部分时,我是否需要做一些复用? ... 在这种视角下,我开发出的接口虽然实现了项目的需求,但是却可能与其在前端的易用性产生割裂。 一个例子 在我之前独立开发的一个数据可视化系统中,存在着这样一个功能: 该项目的数据存在四种层级:team、group、branch、total,这四个层级的数据项都是一样的,现在需要提供接口分别返回这四个层级的数据。 实际开发中,数据库中存在着四张数据表,而我不想使用MyBatis的 ${} 以字符串拼接的形式来生成SQL,于是我写了四个逻辑几乎完全相同的Service类,最终反映到Controller上,就是每个层级的数据都有一个API去获取数据。当然,后端这里应该有更好的处理方式,不过暂且按下不表。当我终于大致完成后端的接口设计,转而开发前端时,才发现我接口设计的不合理之处。首先,前端要配置多个axios,其次,发送请求时,前端需要编写多余的代码去选择要调用哪个API

C# library for converting json schema to sample JSON

眉间皱痕 提交于 2020-08-03 02:48:55
问题 I'm looking for a C# library that will generate a valid JSON object based on a given JSON Schema. I'd like to produce a very simple JSON sample just like how Swagger does it: I've seen some JavaScript libraries like JSON Schema Faker, but I need a C#/.Net library where I can generate sample JSON in my backend code. 回答1: Ok, it is super simplistic and doesn't take into account many factors of JSON schema, but it might be a good enough starting point for you. It also depends on the JsonSchema

C# library for converting json schema to sample JSON

与世无争的帅哥 提交于 2020-08-03 02:48:49
问题 I'm looking for a C# library that will generate a valid JSON object based on a given JSON Schema. I'd like to produce a very simple JSON sample just like how Swagger does it: I've seen some JavaScript libraries like JSON Schema Faker, but I need a C#/.Net library where I can generate sample JSON in my backend code. 回答1: Ok, it is super simplistic and doesn't take into account many factors of JSON schema, but it might be a good enough starting point for you. It also depends on the JsonSchema

How can I generate swagger based off of existing postman collection? [closed]

南笙酒味 提交于 2020-07-31 06:17:13
问题 Closed . This question needs to be more focused. It is not currently accepting answers. Want to improve this question? Update the question so it focuses on one problem only by editing this post. Closed 2 years ago . Improve this question I am developing a REST API. during development I have used postman (chrome extension) to use and document my API. It is a wonderful tool and I have most of my API endpoints in it. However, as we near release I would like to document this API in swagger, how

How can I generate swagger based off of existing postman collection? [closed]

天大地大妈咪最大 提交于 2020-07-31 06:16:10
问题 Closed . This question needs to be more focused. It is not currently accepting answers. Want to improve this question? Update the question so it focuses on one problem only by editing this post. Closed 2 years ago . Improve this question I am developing a REST API. during development I have used postman (chrome extension) to use and document my API. It is a wonderful tool and I have most of my API endpoints in it. However, as we near release I would like to document this API in swagger, how