登录
首页 >  Golang >  Go问答

如何使用beego生成离线swagger文档

来源:stackoverflow

时间:2024-04-10 19:45:32 233浏览 收藏

最近发现不少小伙伴都对Golang很感兴趣,所以今天继续给大家介绍Golang相关的知识,本文《如何使用beego生成离线swagger文档》主要内容涉及到等等知识点,希望能帮到你!当然如果阅读本文时存在不同想法,可以在评论中表达,但是请勿使用过激的措辞~

问题内容

我正在使用 beego 开发一个网站,我想使用 swagger 生成文档。

beego官方文档向我们展示了如何使用swagger生成文档:https://beego.me/docs/advantage/docs.md

我已经按照上面的文档成功生成了 swagger 文档。

但是,该文档不是离线的,这意味着我必须保持网站服务器运行才能使用在线文档。

是否可以生成一种离线文档?


解决方案


要生成离线 swagger,我启动本地服务器(例如 localhost:8088/swagger/)并运行

docker run -e "java_mem=1024m" -e "http_port=80" -p 8888:80 --name swagger-generator-v3 -v /tmp:/jetty_home/lib/shared swaggerapi/swagger-generator-v3

当 swagger 生成器打开时:http://localhost:8888/index.html

使用“post”/生成带有参数的路由(“lang”:“html”或“lang”:“html2”)

{
    "lang": "html",
    "specurl": "http://172.17.0.1:8088/swagger/swagger.json"
}

点击“执行”并获取“下载文件”

或者使用这个 bash 脚本:

#!/bin/bash

OUTFILE="offline_swagger.zip"
HOST=127.0.0.1
SWAGGER_IP_PORT=8090

DOCKER_IP=$(ip addr show | grep "\binet\b.*\bdocker0\b" | awk '{print $2}' | cut -d '/' -f 1)
SWAGGERJSON=http://$DOCKER_IP:$SWAGGER_IP_PORT/swagger/swagger.json
API_URL="http://$HOST:8888/api/generate"

generate_post_data()
{
  cat <

到这里,我们也就讲完了《如何使用beego生成离线swagger文档》的内容了。个人认为,基础知识的学习和巩固,是为了更好的将其运用到项目中,欢迎关注golang学习网公众号,带你了解更多关于的知识点!

声明:本文转载于:stackoverflow 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>