网站网页切换怎么做的,旅游示范校建设专题网站,在哪里可以找到做网站的公司,织梦网站查看原有文章背景如果我们之前搞过java web开发#xff0c;我们应该都知道swagger这个API文档自动生成利器#xff0c;有了swagger可以方便我们与客户端的联调#xff0c;基本上是一目了然#xff0c;swagger支持java#xff0c;自然它也能支持golang的gin框架#xff0c;本小节…背景如果我们之前搞过java web开发我们应该都知道swagger这个API文档自动生成利器有了swagger可以方便我们与客户端的联调基本上是一目了然swagger支持java自然它也能支持golang的gin框架本小节就花费5分钟的时间快速整合一下gin和swagger我们将在上一个分层的gin实战基础上我们开始整合swaggerswaggerswagger的github地址https://github.com/swaggo/gin-swaggerStep1打开我们上一个小节搭建的工程整体结构图如下图所示项目骨架图我们打开goland的一个终端运行如下命令go get -u github.com/swaggo/swag/cmd/swag在沒有报错的情况下再运行swag init这个时候你会发现你的项目中多了一个文件夹Step2在完成Step1之后swagger的依赖基本上我们都有了接下来我们就要gin对swagger的url映射或者我们在访问浏览器的时候我们怎么知道对应请求Swagger页面的URL呢我们回到我们之前配置映射的地方如下图所示我们一开始只有一个对/movie/get/:id的依赖接下来我们要新增对swagger的映射修改一下代码编程如下这个一般是固定格式但是我们也要稍微了解一下其中的原理其实并不复杂如下代码所示下面第二处标红的表示我们多加一个GET映射以/swagger前缀开头的都交给你ginSwagger.WrapHandler这个处理器处理好了到此我们重新运行一下swag init然后打开浏览器访问如下地址http://localhost:8080/swagger/index.html到此为止我们已经初步看到了swagger的熟悉的页面了虽然有报错但这是我们前进的一大步接下来我们一步步进行润色就可以了Step3我们为我们的swagger新增标题和说明在golang中我们只需要写一些注解就可以达到上述的效果我们在main函数中增加如下的注释和引入一下swagger doc的依赖如下所示重新运行swag init重启项目再次打开浏览器再次访问上述网址我们发现项目不再报错也可以看到该文档的一些基本信息不报错的swagger页面Step4为/movie/get/:id 新增接口说明在spring mvc中我们可以在接口方法上加一些注解然后在入参和出参上加一些特定注解说明参数含义然后swagger就会自动帮助我们变成接口说明在golang中也是一样我们再handlers中的各个func上加注释而不是加注解也可以完成一样的工作我们在GetMovieById上加上如下的注释然后再次运行swag init就可以完成第一个接口说明了重启系统然后再次访问浏览器我们可以看到最后的成果就出来了并且我们可以成功的在里面请求我们的系统接口了小结简而言之golang版的swagger还是比较易懂好用并且容易上手的但是我们每次修改完注释都要重新swag init重新生成最新的文档说明这个也是我们要做注意的下一个小节我们将完整的编写关于电影数据库的增删改查的功能
