草庐IT

go - 如何在 Swagger 中创建前缀路由

coder 2024-07-10 原文

通常 swagger 提供的示例设置简单的服务器,其中对 json 函数的所有 api 调用都在文档根目录中。 例如著名的“hello world”位于“/hello”。

我想找到一种方法来定义给定的前缀,以便可以将特定的 api 放在这个前缀下。如果前缀为“/api/2.0”,则示例 api 将变为

/hello   --> /api/2.0/hello   # The prefix would be "/api/2.0"
/goodbye --> /api/2.0/goodbye # 

最后我想保持这种动态并真正提供一些命令行开关

server -prefix '/api/2.0'

服务器会将其用于 api。请注意,我也可以不指定前缀,系统应该回退到“/hello”和“/goodbye”。

swagger ( https://github.com/go-swagger/go-swagger ) 的 go-lang 实现是否可行

有人能给我举个例子/或举个简短的例子吗?

附录: 我想基本上使用 swagger 2.0 界面来完成此操作。 我现在了解到它需要这样的东西:

http.Handle("/", middlewareOne(middlewareTwo(finalHandler)))

基本上,任务是让 swagger 生成的“finalHandler”保持不变(因此它认为仍然“仅”处理/hello 或/goodbye)。但是中间件会在 finalHandler 之前捕获所有流量。 “/api/2.0”将被删除/转换(这是我正在搜索的内容,如何???)并且中间件会将其传递给最终处理程序,它仍然认为它服务于/hello。我不确定是否需要它运行“/api/2.0”的信息,但也许它应该作为上下文添加。

https://github.com/go-swagger/go-swagger/blob/master/docs/use/middleware.md

奇怪的解决方案,似乎有效。

func setupGlobalMiddleware(handler http.Handler) http.Handler {
  prefix:="/api/2.0"
  return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    if strings.HasPrefix(r.URL.Path, prefix) {
       r.URL.Path = r.URL.Path[len(prefix):]
    }
    handler.ServeHTTP(w, r)
  })
}

如果可以访问生成代码中的“处理程序”映射,我宁愿更喜欢,但它不可访问。这样我就可以用前缀“重新注册”所有东西。也许有更好的解决方案?

最佳答案

简单的示例代码。享受。

package main

import (
    "github.com/julienschmidt/httprouter"
    "net/http"
    "log"
)
type (
    API interface {
        Hello(w http.ResponseWriter, r *http.Request)
        Goodbye(w http.ResponseWriter, r *http.Request)
    }
    API2 struct {}
    API3 struct {}
)

func main() {
    mux := httprouter.New()
    mux.GET("/api/:version/:command",API_HANDLER)
    log.Fatal(http.ListenAndServe(":8091", mux))
}
//---------------------------------------------------------------------------
//  HANDLERS
//---------------------------------------------------------------------------
func API_HANDLER(w http.ResponseWriter, r *http.Request, p httprouter.Params){
    var hand API
    switch p.ByName("version") {
    case "2.0": hand = API2{}
    case "3.0": hand = API3{}
    default: hand = nil
    }
    switch p.ByName("command") {
        case "hello": hand.Hello(w,r)
        case "goodbye": hand.Goodbye(w,r)
    }
}
//---------------------------------------------------------------------------
//  API2 version
//---------------------------------------------------------------------------
func (a API2) Hello(w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("[API2] Hello"))
}
func (a API2) Goodbye (w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("[API2] Goodbye"))
}

//---------------------------------------------------------------------------
//  API3 version
//---------------------------------------------------------------------------
func (a API3) Hello(w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("[API3] Hello"))
}
func (a API3) Goodbye (w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("[API3] Goodbye"))
}

关于go - 如何在 Swagger 中创建前缀路由,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/42606535/

有关go - 如何在 Swagger 中创建前缀路由的更多相关文章

  1. ruby - 如何在 Ruby 中顺序创建 PI - 2

    出于纯粹的兴趣,我很好奇如何按顺序创建PI,而不是在过程结果之后生成数字,而是让数字在过程本身生成时显示。如果是这种情况,那么数字可以自行产生,我可以对以前看到的数字实现垃圾收集,从而创建一个无限系列。结果只是在Pi系列之后每秒生成一个数字。这是我通过互联网筛选的结果:这是流行的计算机友好算法,类机器算法:defarccot(x,unity)xpow=unity/xn=1sign=1sum=0loopdoterm=xpow/nbreakifterm==0sum+=sign*(xpow/n)xpow/=x*xn+=2sign=-signendsumenddefcalc_pi(digits

  2. ruby-on-rails - Rails 3 中的多个路由文件 - 2

    Rails2.3可以选择随时使用RouteSet#add_configuration_file添加更多路由。是否可以在Rails3项目中做同样的事情? 最佳答案 在config/application.rb中:config.paths.config.routes在Rails3.2(也可能是Rails3.1)中,使用:config.paths["config/routes"] 关于ruby-on-rails-Rails3中的多个路由文件,我们在StackOverflow上找到一个类似的问题

  3. ruby - 如何在 buildr 项目中使用 Ruby 代码? - 2

    如何在buildr项目中使用Ruby?我在很多不同的项目中使用过Ruby、JRuby、Java和Clojure。我目前正在使用我的标准Ruby开发一个模拟应用程序,我想尝试使用Clojure后端(我确实喜欢功能代码)以及JRubygui和测试套件。我还可以看到在未来的不同项目中使用Scala作为后端。我想我要为我的项目尝试一下buildr(http://buildr.apache.org/),但我注意到buildr似乎没有设置为在项目中使用JRuby代码本身!这看起来有点傻,因为该工具旨在统一通用的JVM语言并且是在ruby中构建的。除了将输出的jar包含在一个独特的、仅限ruby​​

  4. ruby - 什么是填充的 Base64 编码字符串以及如何在 ruby​​ 中生成它们? - 2

    我正在使用的第三方API的文档状态:"[O]urAPIonlyacceptspaddedBase64encodedstrings."什么是“填充的Base64编码字符串”以及如何在Ruby中生成它们。下面的代码是我第一次尝试创建转换为Base64的JSON格式数据。xa=Base64.encode64(a.to_json) 最佳答案 他们说的padding其实就是Base64本身的一部分。它是末尾的“=”和“==”。Base64将3个字节的数据包编码为4个编码字符。所以如果你的输入数据有长度n和n%3=1=>"=="末尾用于填充n%

  5. ruby-on-rails - 如何在 ruby​​ 中使用两个参数异步运行 exe? - 2

    exe应该在我打开页面时运行。异步进程需要运行。有什么方法可以在ruby​​中使用两个参数异步运行exe吗?我已经尝试过ruby​​命令-system()、exec()但它正在等待过程完成。我需要用参数启动exe,无需等待进程完成是否有任何ruby​​gems会支持我的问题? 最佳答案 您可以使用Process.spawn和Process.wait2:pid=Process.spawn'your.exe','--option'#Later...pid,status=Process.wait2pid您的程序将作为解释器的子进程执行。除

  6. ruby - 如何在续集中重新加载表模式? - 2

    鉴于我有以下迁移:Sequel.migrationdoupdoalter_table:usersdoadd_column:is_admin,:default=>falseend#SequelrunsaDESCRIBEtablestatement,whenthemodelisloaded.#Atthispoint,itdoesnotknowthatusershaveais_adminflag.#Soitfails.@user=User.find(:email=>"admin@fancy-startup.example")@user.is_admin=true@user.save!ende

  7. ruby - 如何在 Ruby 中拆分参数字符串 Bash 样式? - 2

    我正在为一个项目制作一个简单的shell,我希望像在Bash中一样解析参数字符串。foobar"helloworld"fooz应该变成:["foo","bar","helloworld","fooz"]等等。到目前为止,我一直在使用CSV::parse_line,将列分隔符设置为""和.compact输出。问题是我现在必须选择是要支持单引号还是双引号。CSV不支持超过一个分隔符。Python有一个名为shlex的模块:>>>shlex.split("Test'helloworld'foo")['Test','helloworld','foo']>>>shlex.split('Test"

  8. ruby - 如何在 Lion 上安装 Xcode 4.6,需要用 RVM 升级 ruby - 2

    我实际上是在尝试使用RVM在我的OSX10.7.5上更新ruby,并在输入以下命令后:rvminstallruby我得到了以下回复:Searchingforbinaryrubies,thismighttakesometime.Checkingrequirementsforosx.Installingrequirementsforosx.Updatingsystem.......Errorrunning'requirements_osx_brew_update_systemruby-2.0.0-p247',pleaseread/Users/username/.rvm/log/138121

  9. ruby-on-rails - 如何在 ruby​​ 交互式 shell 中有多行? - 2

    这可能是个愚蠢的问题。但是,我是一个新手......你怎么能在交互式ruby​​shell中有多行代码?好像你只能有一条长线。按回车键运行代码。无论如何我可以在不运行代码的情况下跳到下一行吗?再次抱歉,如果这是一个愚蠢的问题。谢谢。 最佳答案 这是一个例子:2.1.2:053>a=1=>12.1.2:054>b=2=>22.1.2:055>a+b=>32.1.2:056>ifa>b#Thecode‘if..."startsthedefinitionoftheconditionalstatement.2.1.2:057?>puts"f

  10. ruby-on-rails - 如何在我的 Rails 应用程序 View 中打印 ruby​​ 变量的内容? - 2

    我是一个Rails初学者,但我想从我的RailsView(html.haml文件)中查看Ruby变量的内容。我试图在ruby​​中打印出变量(认为它会在终端中出现),但没有得到任何结果。有什么建议吗?我知道Rails调试器,但更喜欢使用inspect来打印我的变量。 最佳答案 您可以在View中使用puts方法将信息输出到服务器控制台。您应该能够在View中的任何位置使用Haml执行以下操作:-puts@my_variable.inspect 关于ruby-on-rails-如何在我的R

随机推荐