可视化grape swagger-ui

swagger-docs :

https://github.com/richhollis/swagger-docs
swagger-docs-sample:  
https://github.com/richhollis/swagger-docs-sample/blob/master/README.md

swagger-ui: https://github.com/wordnik/swagger-ui

1、vim Gemfile 添加  gem ‘swagger-docs‘ 然后
bundle    或者直接
gem install
swagger-docs

2、cd rails项目目录;   vim config/initializers/swagger_docs.rb , 并添加保存如下内容:
 Swagger::Docs::Config.register_apis({
    "1.0" => {:base_path => "http://localhost:3000", :api_file_path => "public"}
  })
3、在某个controller中添加:
   swagger_controller :user_api, "UserApi"
 
   swagger_api :index do
    summary "test"
    response :unauthorized
    response :not_acceptable
   end

   def index
     render :json => {result:"Success"}, :status => 200
   end

4、rake swagger:docs
5、rails s
6、cd public
7、git clone https://github.com/wordnik/swagger-ui.git
8、vim swagger-ui/dist/index.html
   将 url 修改为 http://localhost:3000/api-docs.json
   window.swaggerUi = new SwaggerUi({
      url: "http://localhost:3000/api-docs.json",
           //http://petstore.swagger.wordnik.com/api/api-docs     
      dom_id: "swagger-ui-container",
      supportedSubmitMethods: [‘get‘, ‘post‘, ‘put‘, ‘delete‘],
      ... ... ...
9、浏览器中输入 http://localhost:3000/swagger-ui/dist/index.html
即可查看并测试api


如果页面打开慢,vim public/swagger-ui/dist/index.html ,
将 ...fonts.googleapis.com/css...这行代码注释掉。

注: config/routes.rb 中 swagger对应的route 不要用match, 否则会报错
时间: 2024-10-16 14:46:30

可视化grape swagger-ui的相关文章

gRPC helloworld service, RESTful JSON API gateway and swagger UI

概述 本篇博文完整讲述了如果通过 protocol buffers 定义并启动一个 gRPC 服务,然后在 gRPC 服务上提供一个 RESTful JSON API 的反向代理 gateway,最后通过 swagger ui 来提供 RESTful JSON API 的说明,完整代码 helloworld_restful_swagger. Helloworld gRPC Service 参考 gRPC Quick Start for Python. Install gRPC 安装 gRPC 运

java swagger ui 添加header请求头参数

我用到的swagger 主要有三款产品,swagger editor,swagger ui 和swagger codegen. swagger editor:主要是一个本地客户端,用来自己添加api,自己来测试,相当于一个api的可视化测试工具和定义工具吧. swagger ui:主要用户嵌入到项目中,将所有的接口生成一个可视化的页面,方便前后端联调 swagger codegen:主要用于通过swagger来自动生成代码 我用的swagger ui主要在java项目中.将所有的http接口提供

Swagger UI使用指南

1:认识Swagger Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步. 作用:     1. 接口的文档在线自动生成.     2. 功能测试.  Swagger是一组开源项目,其中主要要项目如下: 1.   Swagger-tools:提供各种与Swagger进行集成和交互的工具.例如模式检验.Swag

Swagger UI教程 API 文档神器 搭配Node使用

ASP.NET Web API 使用Swagger生成在线帮助测试文档 Swagger 生成 ASP.NET Web API 前言 swagger ui是一个API在线文档生成和测试的利器,目前发现最好用的. 为什么好用?Demo 传送门 支持API自动生成同步的在线文档 这些文档可用于项目内部API审核 方便测试人员了解API 这些文档可作为客户产品文档的一部分进行发布 支持API规范生成代码,生成的客户端和服务器端骨架代码可以加速开发和测试速度 总结一句话就是好用,逼格高.下面我将总结一下如

swagger ui js 错误:Failed to execute 'serializeToString' on 'XMLSerializer': parameter 1 is not of type 'Node'.

经过排查,引发此错误的原因是,表中有一个字段名称为"NodeName",应该是在前台xml解析时引发冲突所致.我的解决办法是: 修改列名,修改映射. 如下: [Column("NodeName")] public string Name { get; set; } ps:说下我的思路,前台错误处打上断点,循环跳出(或者F8),注意观察出错时的节点名,见下图: 根据此法快速定位到解析错误的表名,然后根据排除法,一个一个注释掉字段,找到出错的字段.剩下的就好办了. sw

使用 Swagger UI 与 Swashbuckle 创建 RESTful Web API 帮助文件

作者:Sreekanth Mothukuru 2016年2月18日 本文旨在介绍如何使用常用的 Swagger 和 Swashbuckle 框架创建描述 Restful API 的交互界面,并为 API 用户提供丰富的探索.文件和操作体验. 源代码: 下载 SwaggerUi_2.zip 步骤 在本文中,我们将在 Asp.Net 创建一个简单的 Restful API,并整合 Swashbuckle 和 Swagger UI.本文分为三部分. 创建 Asp.Net Web API项目 通过实体数

Swagger UI教程 API 文档神器 搭配Node使用 web api 接口文档 mvc接口文档

两种方案 一.Swagger 配置 web Api 接口文档美化 二.通过NodeJS 发布Swagger UI 配置api 文档 先说一下简单的 Swagger 配置 web Api  Swagger-UI本身只提供在线测试功能,要集成它还需要告诉它本项目提供的各种服务和参数信息.这里就需要一些工作量了,不过好在许多第三方库已经给我们完成了这一工作.我这里用的是Swashbuckle,使用它也比较简单,直接使用Nuget添加其程序包即可: 1.初始化包  PM> Install-Package

RESTful Web API Help Documentation using Swagger UI and Swashbuckle

Sign in home articles Chapters and Sections> Search Latest Articles Latest Tips/Tricks Top Articles Beginner Articles Technical Blogs Posting/Update Guidelines Article Help Forum Article Competition  Submit an article or tip  Post your Blog quick ans

ASP.NET Zero--基于令牌的认证&SWAGGER UI

基于令牌的认证 任何应用程序都可以将应用程序中的任何功能认证和使用为API.例如,您可以创建一个移动应用程序消耗相同的API.在本节中,我们将演示来自Postman的API (Google Chrome扩展程序)的用法. 认证 我们建议您禁用用于远程身份验证的用户的双因素身份验证.否则,客户端应该实现两个因素认证流程.我们假设您已经 为默认租户的管理员用户禁用了双因素身份验证,因为我们将在此示例中使用它. 应为所有请求配置以下标题(Abp.TenantId为默认租户的Id),单个租户应用程序不需

Authorize requests in Swagger UI

Authorize requests in Swagger UI 前面的文章讲到了Swagger+ASP.NET Core的使用,这里讲怎么把授权认证加入Swagger中. 国外的一篇文章:https://ppolyzos.com/2017/10/30/add-jwt-bearer-authorization-to-swagger-and-asp-net-core/ app.UseSwaggerUi3(typeof(Startup).GetTypeInfo().Assembly, setting