Swagger UI

目录 文章目录 目录 一个 RESTful API 框架需要什么？ go-restful 核心概念 Route WebService Container 过滤器（Filter） 响应编码（Response Encoding） 代码示例一 代码示例二 一个 RESTful API 框架需要什么？ 从应用程序开发的角度来看，RESTful API 的本质是一个 Web Application，而 RESTful API 框架就是实现这个 Web Application 所封装的一些列工具库，使开发者可以忽略底层实现的复杂度，专注以自身 Application 的逻辑设计。 一个 RESTful API 框架应该具备以下几个元素： Resources ：资源的定义，即 HTTP URI（或称之为 HTTP URL Path）的定义。RESTful API 的设计围绕着 Resource 进行建模。 Handlers ：资源处理器，是资源业务逻辑处理的具体实现。 Request Routers ：资源请求路由器，完成 HTTP URIs、HTTP Request Methods 和 Handlers 三者之间的映射与路由。 Request Verification Schemas ：HTTP Request Body 校验器，验证请求实体的合法性。 Response View

1 背景 springBoot作为微服务首选框架，为其他服务提供大量的接口服务。接口对接方需要实时最近的接口文档。 swagger可以通过 代码和注释 自动为web项目生成在线文档，这里使用swagger。 swagger官网地址： https://swagger.io/ 2 使用 2.1 maven依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> 依赖说明： （1）springfox-swagger2 检测spring的web请求信息，生成检测结果（ json格式 ）。 （2）springfox-swagger-ui 根据springfox-swagger2生成的数据，生成 可视化 的友好页面。 2.2 配置代码 Springfox提供Docket对象，为其设置相关属性，将其注册成为spring的bean后

Env env description alpha 开发环境 beta 测试环境 gamma 预发环境 delta 生产环境 common 通用环境 Service env service ip port username passwd gamma mysql 192.168.3.73 3306 root gamma redis 192.168.3.71 6379 - gamma nacos 192.168.3.74 8848 - - gamma api-usr 192.168.3.77 19000 - - gamma api-ops 192.168.3.77 19001 - - gamma user 192.168.3.77 - - - common nginx 192.168.3.73 80/443 - - common gitlab 192.168.3.78 80 - - common zentao 192.168.3.77 80 - - common jenkins 192.168.3.68 8080 - - Deployment directory host directory 192.168.3.77～192.168.3.77 /data/dph/service/dph-service-xxxx-impl/ 192.168.3.77 /data/dph/api/dph

在实际开发过程中，前后端分离后，那么势必存在如何在多人协作中共享和及时更新API开发接口文档的问题，维护接口文档就变成了必不可少的工作，在初期开发的时候接口一直处在变化中，每次接口更新，都要去单独维护接口文档，做过的老铁都知道这是一件多么令人脑瓜子疼得事。使用swagger2集成文档，有多个优势: 功能丰富 ：支持多种注解，自动生成接口文档界面，支持在界面测试API接口功能； 及时更新 ：开发过程中养成写注释的习惯，就可以及时的更新API文档； 整合简单 ：通过添加pom依赖和简单配置，内嵌于应用中就可同时发布API接口文档界面，不需要部署独立服务。 引入依赖 首先是创建一个Spring Boot项目，引入web依赖，引入swagger2相关的依赖，如下： web依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> swagger2依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency>

retrofit：一套RESTful架构的Android(Java)客户端实现。 好处： 基于注解 提供 JSON to POJO ， POJO to JSON ， 网络请求 (POST，GET,PUT，DELETE等)封装 可以看做是对HttpClient的再次封装 1、为了做测试，建立了一个新的springboot项目"myboot2"，项目结构如下： 1.1、pom.xml 1 <? xml version="1.0" encoding="UTF-8" ?> 2 < project xmlns ="http://maven.apache.org/POM/4.0.0" xmlns:xsi ="http://www.w3.org/2001/XMLSchema-instance" 3 xsi:schemaLocation ="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd" > 4 5 < modelVersion > 4.0.0 </ modelVersion > 6 7 < groupId > com.xxx </ groupId > 8 < artifactId > myboot2 </ artifactId > 9 < version > 1.0-SNAPSHOT </

1.pom配置： <!-- swagger --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.5.0</version> </dependency> <!-- swagger-ui --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.5.0</version> </dependency> 2. 配置类配置swagger： import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders

一、配置IdentityServer4服务端 这里介绍两种方法 ①直接创建identityserver4的模板，在模板的基础上修改 ②创建新项目，自己搭建 第一种 参考 我的 identityServer4学习 ，创建一个identityServer4模板后 修改config文件 public static IEnumerable<IdentityResource> GetIdentityResources() { return new IdentityResource[] { new IdentityResources.OpenId(), new IdentityResources.Profile(), }; } /// <summary> /// API信息 /// </summary> /// <returns></returns> public static IEnumerable<ApiResource> GetApis() { return new [] { new ApiResource( " ProjectApiScope " , " Demo API with Swagger " ) }; } /// <summary> /// 客服端信息 /// </summary> /// <returns></returns> public static

前言 我们通常把 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

前言 我们通常把 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

前言 建立Web Api项目 在同一个解决方案下建立一个Web Api项目 IdentityServer4.WebApi ,然后修改Web Api的launchSettings.json。参考第一节，当然可以不修改的，端口号为 5001 。 { "profiles": { "IdentityServer4.WebApi": { "commandName": "Project", "launchBrowser": true, "launchUrl": "weatherforecast", "applicationUrl": "http://localhost:5001", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" } } } } 添加Swagger帮助页面 官方文档： https://docs.microsoft.com/en-us/aspnet/core/tutorials/web-api-help-pages-using-swagger?tabs=visual-studio&view=aspnetcore-3.1 在 Startup.ConfigureServices 方法中将Swagger生成器添加到服务集合： public void ConfigureServices