Swagger UI

设想和目标 我们的软件要解决什么问题？是否定义得很清楚？是否对典型用户和典型场景有清晰的描述？ 答：主要是提供一个一站式通知发布、接收平台以及简单的备忘录功能，详见需求规格说明书。 我们达到目标了么（原计划的功能做到了几个？ 按照原计划交付时间交付了么？ 原计划达到的用户数量达到了么?) 答：后端功能基本完成，错误处理待完善。前端还有部分功能没完成，以及界面布局需要优化。 和上一个阶段相比，团队软件工程的质量提高了么？ 在什么地方有提高，具体提高了多少，如何衡量的？ 答：在进度管理和工作安排上有提高，体现在贡献度的计算有公式可依。 用户量, 用户对重要功能的接受程度和我们事先的预想一致么? 我们离目标更近了么? 答：目前还没有给小组外的用户测试使用，但我们觉得离目标更近了。 有什么经验教训? 如果历史重来一遍, 我们会做什么改进? 答：在制定Alpha阶段的计划时，我们对于工作量的估计过于理想，出现了一些偏差，导致项目没能完成预期的任务。在改进上我们会完善前后端的错误处理。 计划 是否有充足的时间来做计划? 答：有比较充足的时间做计划。 团队在计划阶段是如何解决同事们对于计划的不同意见的？ 答：开会讨论解决，没有出现比较大的不同意见。 你原计划的工作是否最后都做完了? 如果有没做完的，为什么? 答：前端有个别模块功能没有完成，是因为冲刺前工作细化不够到位。

需求背景 spring cloud搭建微服务系统，每个业务模块使用swagger开放文档接口查询，在业务网关模块提供swagger文档聚合查询接口，可以通过选择业务模块分类查看。 框架选型、版本及主要功能 spring boot 2.1.6.RELEASE spring cloud Greenwich.SR3 spring cloud gateway 2.1.3.RELEASE 网关组件 knife4j 2.0.1 增强swagger ui样式，网关使用其starter依赖 swagger bootstrap ui 1.9.6 增强swagger ui样式 spring4all-swagger 1.9.0.RELEASE 配置化swagger参数，免去代码开发 模块职责划分 swagger组件 开发一个项目内的swagger-spring-boot-starter，整合swagger bootstrap ui 1.9.6和spring4all-swagger 1.9.0.RELEASE，对外提供@EnableSwagger注解服务 业务模块 引用自定义的swagger-spring-boot-starter，同时在配置文件中添加本模块的swagger基础信息配置。 网关模块 引用knife4j整合swagger，并开发filter、handler

十年河东，十年河西，莫欺少年穷 学无止境，精益求精 首先，本篇教程为基础教程，大牛请翻过，小白值得一看 如下： 1、准备数据 create database StudentDB go use StudentDB go create table Student ( StudentId varchar ( 50 ) primary key , StudentSex nvarchar ( 2 ), StudentName nvarchar ( 50 ), StudentAge int , CreateDate datetime ) insert into Student values ( newid (), ' 女 ' , ' 王娜 ' , 18 , getdate ()) insert into Student values ( newid (), ' 女 ' , ' 李丽 ' , 19 , getdate ()) insert into Student values ( newid (), ' 女 ' , ' 阿卜杜拉 ' , 17 , getdate ()) insert into Student values ( newid (), ' 女 ' , ' 高骏花 ' , 20 , getdate ()) insert into Student values ( newid (),

新建Web API工程 选Empty，勾选Web API，不要选择Web API，那样会把MVC勾上，这里不需要MVC Web API工程属性 XML文件用于生成在线文档 新建Windows服务作为Web API的宿主 WebApiHost工程属性 控制台应用程序方便调试 Windows服务安装Microsoft.AspNet.WebApi.OwinSelfHost 工程WebApiDemo需要引用Microsoft.Owin.dll WebApiDemo安装Swashbuckle 应用程序入口 using System; using System.Collections.Generic; using System.Diagnostics; using System.Linq; using System.ServiceProcess; using System.Text; using System.Threading.Tasks; namespace WebApiHost { static class Program { /// <summary> /// 应用程序的主入口点。 /// </summary> static void Main( string [] args) { RunDebug(); StartService(); } private static void

一、Swagger 1、什么是 Swagger ？ 　　Swagger 是一个规范和完整的框架，用于生成、描述、调用以及可视化的 Restful 风格的 Web 服务。 　　简单的理解：是一款 REST API 文档生成工具，生成在线的接口文档，方便接口测试。 2、为什么使用 Swagger？ 　　前后端分离开发时，为了方便前后端接口调用规范，需要提供一个接口文档，但是维护这个接口文档是一个及其繁琐的事情，可能一不小心就忘记更新该文档从而导致前后端接口调用失败。 　　Swagger 就是为了解决这个问题而出现的（在线接口文档），其在接口方法上定义注解，并根据注解形成一个 html 页面，每次接口修改，这个 html 页面就会发生相应的改变，从而保证了接口文档的正确性。通过该 html 页面，可以很方便、清楚的知道这个接口的功能，并测试。 3、SpringBoot 整合 Swagger？ （1）Step1： 　　导入依赖 jar 包。 <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> < dependency > < groupId > io.springfox </ groupId > < artifactId > springfox-swagger2 </ artifactId

最近 SpringFox 3.0.0 发布了，距离上一次大版本2.9.2足足有2年多时间了。可能看到这个名字，很多读者会有点陌生。但是，只要给大家看一下这两个依赖，你就知道了！ <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>3.0.0</version> <scope>compile</scope> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>3.0.0</version> <scope>compile</scope> </dependency> 当我们在使用Spring MVC写接口的时候，为了生成API文档，为了方便整合Swagger，都是用这个SpringFox的这套封装。但是，自从2.9.2版本更新之后，就一直没有什么动静，也没有更上Spring Boot的大潮流，有一段时间还一直都是写个配置类来为项目添加文档配置的。为此，之前就造了这么个轮子： https://github.com/SpringForAll/spring-boot

前言 上一篇博客介绍了使用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

1，开启swagger ： c.IncludeXmlComments(GetXmlCommentsPath()); protected static string GetXmlCommentsPath() { return string.Format(@"{0}\bin\{1}.xml", System.AppDomain.CurrentDomain.BaseDirectory , Assembly.GetExecutingAssembly().GetName().Name); } 2，在外网访问时swagger提示错误： 当我尝试看到swagger UI时，我很好地获得了API的文档但是在一段时间后它在按钮上显示了一些错误图标 . 错误消息如下所示： [{“level”：“error”，“message”：“无法从文件中读取http：// MYIP / swagger / docs / v1”}] 我不确定是什么导致它 . 如果我刷新它工作并在几秒后显示错误 . 可以对如下代码进行设置： //c.SetValidatorUrl("http://localhost/validator"); c.DisableValidator(); 来源： oschina 链接： https://my.oschina.net/u/4273344/blog/4291488

前言 我们通常把 RPC 用作内部通信，而使用 Restful Api 进行外部通信。为了避免写两套应用，我们使用 grpc-gateway 把 gRPC 转成 HTTP 。服务接收到 HTTP 请求后， grpc-gateway 把它转成 gRPC 进行处理，然后以 JSON 形式返回数据。本篇代码以上篇为基础，最终转成的 Restful Api 支持 bearer token 验证、数据验证，并添加 swagger 文档。 gRPC转成HTTP 编写和编译proto 1.编写simple.proto syntax = "proto3"; package proto; import "github.com/mwitkow/go-proto-validators/validator.proto"; import "go-grpc-example/10-grpc-gateway/proto/google/api/annotations.proto"; message InnerMessage { // some_integer can only be in range (1, 100). int32 some_integer = 1 [(validator.field) = {int_gt: 0, int_lt: 100}]; // some_float can only be in

前言 　　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